-Introduction: what is pyelftools?\r
----------------------------------\r
-\r
-**pyelftools** is a pure-Python library for parsing and analyzing ELF files\r
-and DWARF debugging information. See the\r
-`User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_ for more details.\r
-\r
-Pre-requisites\r
---------------\r
-\r
-As a user of **pyelftools**, one only needs Python to run. It works with\r
-Python versions 2.6 and 2.7 (Python 3 support is planned). For hacking\r
-on **pyelftools** the requirements are a bit more strict, please see the \r
-`hacking guide <https://bitbucket.org/eliben/pyelftools/wiki/Hacking>`_.\r
-\r
-Installing\r
-----------\r
-\r
-When you unzip the source distribution, run::\r
-\r
- > python setup.py install\r
-\r
-Alternatively, **pyelftools** can be installed from PyPI (Python package\r
-index)::\r
-\r
- > pip install pyelftools\r
-\r
-How to use it?\r
---------------\r
-\r
-**pyelftools** is a regular Python library: you import and invoke it from your\r
-own code. For a detailed usage guide and links to examples, please consult the\r
-`user's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_.\r
-\r
-License\r
--------\r
-\r
-**pyelftools** is open source software. Its code is in the public domain. See\r
-the ``LICENSE`` file for more details.\r
-\r
-\r
-\r
-\r
+Introduction: what is pyelftools?
+---------------------------------
+
+**pyelftools** is a pure-Python library for parsing and analyzing ELF files
+and DWARF debugging information. See the
+`User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_ for more details.
+
+Pre-requisites
+--------------
+
+As a user of **pyelftools**, one only needs Python to run. It works with
+Python versions 2.6 and 2.7 (Python 3 support is planned). For hacking
+on **pyelftools** the requirements are a bit more strict, please see the
+`hacking guide <https://bitbucket.org/eliben/pyelftools/wiki/Hacking>`_.
+
+Installing
+----------
+
+When you unzip the source distribution, run::
+
+ > python setup.py install
+
+Alternatively, **pyelftools** can be installed from PyPI (Python package
+index)::
+
+ > pip install pyelftools
+
+How to use it?
+--------------
+
+**pyelftools** is a regular Python library: you import and invoke it from your
+own code. For a detailed usage guide and links to examples, please consult the
+`user's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_.
+
+License
+-------
+
+**pyelftools** is open source software. Its code is in the public domain. See
+the ``LICENSE`` file for more details.
+
+
+
+
* Make sure new version was updated everywhere appropriate
* Packaging done on Linux
* Run ``python setup.py build sdist`` (no 'upload' yet)
-* Untar the created ``dist/pyelftools-x.y.tar.gz`` and make sure everything looks ok
+* Untar the created ``dist/pyelftools-x.y.tar.gz`` and make sure
+ everything looks ok
* Create a virtual env for Python 2:
(``virtualenv -p /usr/bin/python2 ~/test/venv/ZZZ``)
* Use that virtual env executable to install the source tarball
-* Run some examples and see they work
+* Run some examples with the venv and see they work, and run the test suite
* Now build with upload to send it to PyPi
* Test with pip install from some new virtualenv
* If everything is OK, upload the distribution to BitBucket as well