Skip to content

Commit

Permalink
README: mention CI config and make help
Browse files Browse the repository at this point in the history
Signed-off-by: Vincent Stehlé <[email protected]>
  • Loading branch information
vstehle committed Sep 27, 2023
1 parent cf46599 commit 274407f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ new version can be installed with the Python package installer::

Export SPHINXBUILD (see above) if Sphinx was installed with pip3 --user, then follow Make commands below.

**Note**: the ``.github/workflows/main.yaml`` CI configuration file installs the
necessary dependencies for Ubuntu and can be used as an example.

On Fedora
^^^^^^^^^

Expand Down Expand Up @@ -100,6 +103,10 @@ To generate a single HTML page::

Output goes in ``./build`` subdirectory.

To get some help on the available targets::

$ make help

License
=======

Expand Down

0 comments on commit 274407f

Please sign in to comment.