Remove the outdated list of swh.lister submodules from the readme
Link to the user documentation instead. Also add a section on required binary tools.
This commit is contained in:
parent
d70dd84939
commit
ed8de05eea
1 changed files with 20 additions and 23 deletions
43
README.rst
43
README.rst
|
@ -12,36 +12,33 @@ platforms or package managers. As these operations are quite similar, this
|
|||
package provides a set of Python modules abstracting common software origins
|
||||
listing behaviors.
|
||||
|
||||
It also provides several lister implementations, contained in the
|
||||
following Python modules:
|
||||
It also provides several lister implementations, contained in the Python
|
||||
``swh.lister.*`` modules. See `this documentation
|
||||
<https://docs.softwareheritage.org/user/listers.html>`_ for the list of
|
||||
supported listers.
|
||||
|
||||
- ``swh.lister.bitbucket``
|
||||
- ``swh.lister.cgit``
|
||||
- ``swh.lister.cran``
|
||||
- ``swh.lister.debian``
|
||||
- ``swh.lister.gitea``
|
||||
- ``swh.lister.github``
|
||||
- ``swh.lister.gitlab``
|
||||
- ``swh.lister.gnu``
|
||||
- ``swh.lister.gogs``
|
||||
- ``swh.lister.golang``
|
||||
- ``swh.lister.hex``
|
||||
- ``swh.lister.launchpad``
|
||||
- ``swh.lister.maven``
|
||||
- ``swh.lister.npm``
|
||||
- ``swh.lister.packagist``
|
||||
- ``swh.lister.phabricator``
|
||||
- ``swh.lister.pypi``
|
||||
- ``swh.lister.rpm``
|
||||
- ``swh.lister.tuleap``
|
||||
- ``swh.lister.bioconductor``
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
All required dependencies can be found in the ``requirements*.txt`` files
|
||||
All required python dependencies can be found in the ``requirements*.txt`` files
|
||||
located at the root of the repository.
|
||||
|
||||
In order to be able to run all the listers (and thus execute the tests), some
|
||||
tools must be available on your system, namely:
|
||||
|
||||
- ``opam``
|
||||
- ``tar``
|
||||
- ``psql``
|
||||
|
||||
On a Debian-like system, you may use:
|
||||
|
||||
.. code-block: console
|
||||
|
||||
$ sudo apt update
|
||||
$ sudo apt install opam tar postgresql-client-common
|
||||
|
||||
|
||||
Local deployment
|
||||
----------------
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue