Skip to content

Commit 91e4a63

Browse files
authored
Merge pull request #36 from smooroodina/master
Modified description of install commands
2 parents 156ea23 + d661432 commit 91e4a63

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

‎index.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,20 @@ To create your first PDF, simply install the `rst2pdf` tool, write some text, an
2727

2828
### Install rst2pdf
2929

30-
`rst2pdf` requires Python 3.6 or greater.
30+
`rst2pdf` requires Python 3.8 or greater.
3131

32-
**Option 1: install with pip**
32+
**Option 1: install with pipx**
3333

3434
This is the easiest option and will give the most recent stable release.
3535

3636
```
37-
sudo pip install rst2pdf
37+
pipx install rst2pdf
38+
```
39+
40+
rst2pdf also has support for a number of features that require additional dependencies. Installation of all the required dependencies using pipx may be installed using:
41+
42+
```
43+
pipx install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]
3844
```
3945

4046
**Option 2: install from source**
@@ -44,11 +50,9 @@ Choose this option if you want the newest features, or to contribute to the proj
4450
```
4551
git clone https://github.com/rst2pdf/rst2pdf
4652
cd rst2pdf
47-
sudo python setup.py install
53+
pipx install .[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]
4854
```
4955

50-
Note that you may need to use `sudo python3 setup.py install` depending on your configuration.
51-
5256
### Start using rst2pdf
5357

5458
Start with a text file. `rst2pdf` uses [ReStructured Text](http://docutils.sourceforge.net/rst.html) which is a markup format similar to (but a bit more detailed than) markdown. Here's an example file to get you started:

0 commit comments

Comments
 (0)