Skip to content

Commit 580ff92

Browse files
authored
Merge pull request #1 from smooroodina/smooroodina-patch-1
Modified description of install commands
2 parents 156ea23 + 96133da commit 580ff92

1 file changed

Lines changed: 20 additions & 7 deletions

File tree

‎index.md‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,28 +27,41 @@ 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
3838
```
3939

40-
**Option 2: install from source**
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]
44+
```
45+
46+
**Option 2: install with snap**
47+
48+
If you are using a system that supports [snaps](https://snapcraft.io/)
49+
then you can install from there with:
50+
51+
```
52+
snap install rst2pdf
53+
```
54+
55+
**Option 3: install from source**
4156

4257
Choose this option if you want the newest features, or to contribute to the project.
4358

4459
```
4560
git clone https://github.com/rst2pdf/rst2pdf
4661
cd rst2pdf
47-
sudo python setup.py install
62+
pipx install .[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]
4863
```
4964

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

5467
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)