From 3c199f109f6400acce43f7459837aeb0ed7ddfc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Fri, 29 May 2020 11:37:39 -0400 Subject: [PATCH] Document the new `docutils` optional dep. and link to the man pages README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Louis-Philippe Véronneau --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8738be8..677eed4 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: