Fix for mixed version loclists, tests (#521)

[pyelftools.git] / README.rst

diff --git a/README.rst b/README.rst
index d668f3b35f98667565bad88d4ec5bce626ce1ccb..b665971b3183555b797c6e6db769bb07ae2ab367 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,10 @@
-Introduction: what is pyelftools?
----------------------------------
+==========
+pyelftools
+==========
+
+.. image:: https://github.com/eliben/pyelftools/workflows/pyelftools-tests/badge.svg
+  :align: center
+  :target: https://github.com/eliben/pyelftools/actions
 
 **pyelftools** is a pure-Python library for parsing and analyzing ELF files
 and DWARF debugging information. See the
@@ -9,10 +14,10 @@ for more details.
 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
-requirements are a bit more strict, please see the
-`hacking guide <https://github.com/eliben/pyelftools/wiki/Hacking-guide>`_.
+As a user of **pyelftools**, one only needs Python 3 to run. While there is no
+reason for the library to not work on earlier versions of Python 3, our CI
+tests are based on the officual
+`Status of Python versions <https://devguide.python.org/versions/>`__.
 
 Installing
 ----------
@@ -33,6 +38,9 @@ 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?
 --------------
 
@@ -40,18 +48,13 @@ How to use it?
 own code. For a detailed usage guide and links to examples, please consult the
 `user's guide <https://github.com/eliben/pyelftools/wiki/User's-guide>`_.
 
+Contributing
+------------
+
+See the `Hacking Guide <https://github.com/eliben/pyelftools/wiki/Hacking-guide>`__.
+
 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