Skip to content

Commit

Permalink
Document the new docutils optional dep. and link to the man pages
Browse files Browse the repository at this point in the history
README

Signed-off-by: Louis-Philippe Véronneau <pollo@debian.org>
  • Loading branch information
baldurmen authored and JoeLametta committed May 30, 2020
1 parent abcdd06 commit 3c199f1
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,11 @@ PyPI installable dependencies are listed in the [requirements.txt](https://githu

### Optional dependencies
- [Pillow](https://pypi.org/project/Pillow/), for completely supporting the cover art feature (`embed` and `complete` option values won't work otherwise).
- [docutils](https://pypi.org/project/docutils/), to build the man pages.

This dependency isn't listed in the `requirements.txt`, to install it just issue the following command:
These dependencies are not listed in the `requirements.txt`. To install them, just issue the following command:

`pip3 install Pillow`
`pip3 install Pillow docutils`

### Fetching the source code

Expand Down Expand Up @@ -197,6 +198,8 @@ is correct, while

is not, because the `-d` argument applies to the `cd` command.

A more complete set of usage instructions can be found in the `whipper` [man pages](https://github.com/whipper-team/whipper/blob/develop/man/README.md).

## Getting started

The simplest way to get started making accurate rips is:
Expand Down

0 comments on commit 3c199f1

Please sign in to comment.