Rename test files with .debug
[pyelftools.git] / README.rst
index d668f3b35f98667565bad88d4ec5bce626ce1ccb..6b59c0ff605475468abb3d227903ccf5e130f67c 100644 (file)
@@ -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
@@ -10,7 +15,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 >= 5). For hacking on **pyelftools** the
 requirements are a bit more strict, please see the
 `hacking guide <https://github.com/eliben/pyelftools/wiki/Hacking-guide>`_.
 
@@ -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?
 --------------
 
@@ -45,13 +53,3 @@ 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