readelf.py: adapt section mapping output for .tbss sections (#289)
[pyelftools.git] / README.rst
index afd6da802fcde848e634c7abde9f017506c38f8a..c16edbdd68c313ae4492476a20e8457d18713d8a 100644 (file)
@@ -10,7 +10,7 @@ Pre-requisites
 --------------
 
 As a user of **pyelftools**, one only needs Python to run. It works with
-Python versions 2.6, 2.7 and 3.x (x >= 2). For hacking on **pyelftools** the
+Python versions 2.7 and 3.x (x >= 4). For hacking on **pyelftools** the
 requirements are a bit more strict, please see the
 `hacking guide <https://github.com/eliben/pyelftools/wiki/Hacking-guide>`_.
 
@@ -29,8 +29,12 @@ install from source, as usual::
     > python setup.py install
 
 Since **pyelftools** is a work in progress, it's recommended to have the most
-recent version of the code. This can be done by downloading the ``tip`` tag
-("trunk") from *Downloads* or just cloning the Mercurial repository.
+recent version of the code. This can be done by downloading the `master zip
+file <https://github.com/eliben/pyelftools/archive/master.zip>`_ or just
+cloning the Git repository.
+
+Since **pyelftools** has no external dependencies, it's also easy to use it
+without installing, by locally adjusting ``PYTHONPATH``.
 
 How to use it?
 --------------
@@ -45,6 +49,12 @@ License
 **pyelftools** is open source software. Its code is in the public domain. See
 the ``LICENSE`` file for more details.
 
+CI Status
+---------
 
+**pyelftools** has automatic testing enabled through the convenient
+`Travis CI project <https://travis-ci.org>`_. Here is the latest build status:
 
-
+.. image:: https://travis-ci.org/eliben/pyelftools.png?branch=master
+  :align: center
+  :target: https://travis-ci.org/eliben/pyelftools