Fix for mixed version loclists, tests (#521)

[pyelftools.git] / README.rst

diff --git a/README.rst b/README.rst
index 07bd671cb72a4914b9662c647424b90358cddcc7..b665971b3183555b797c6e6db769bb07ae2ab367 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,18 +1,23 @@
-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
-`User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_
+`User's guide <https://github.com/eliben/pyelftools/wiki/User's-guide>`_
 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://bitbucket.org/eliben/pyelftools/wiki/Hacking>`_.
+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
 ----------
@@ -23,28 +28,33 @@ Installing
 
 Alternatively, you can download the source distribution for the most recent and
 historic versions from the *Downloads* tab on the `pyelftools project page
-<https://bitbucket.org/eliben/pyelftools>`_ (by going to *Tags*). Then, you can
+<https://github.com/eliben/pyelftools>`_ (by going to *Tags*). Then, you can
 install from source, as usual::
 
     > python setup.py install
 
-Since **pyelftools** is a work in progress, it's recommended to get the ``tip``
-tag ("trunk") from *Downloads* or just clone the Mercurial repository, to get
-the latest code.
+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 `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?
 --------------
 
 **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>`_.
+`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.
-
-
-
-