src/third_party/pyelftools/README

   1 Introduction: what is pyelftools?
   2 ---------------------------------
   3
   4 **pyelftools** is a pure-Python library for parsing and analyzing ELF files
   5 and DWARF debugging information. See the
   6 `User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_ for more details.
   7
   8 Pre-requisites
   9 --------------
  10
  11 As a user of **pyelftools**, one only needs Python to run. It works with
  12 Python versions 2.6, 2.7 and 3.2. For hacking on **pyelftools** the
  13 requirements are a bit more strict, please see the
  14 `hacking guide <https://bitbucket.org/eliben/pyelftools/wiki/Hacking>`_.
  15
  16 Installing
  17 ----------
  18
  19 When you unzip the source distribution, run::
  20
  21     > python setup.py install
  22
  23 Alternatively, **pyelftools** can be installed from PyPI (Python package
  24 index)::
  25
  26     > pip install pyelftools
  27
  28 How to use it?
  29 --------------
  30
  31 **pyelftools** is a regular Python library: you import and invoke it from your
  32 own code. For a detailed usage guide and links to examples, please consult the
  33 `user's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_.
  34
  35 License
  36 -------
  37
  38 **pyelftools** is open source software. Its code is in the public domain. See
  39 the ``LICENSE`` file for more details.
  40
  41
  42
  43