diff --git a/README.md b/README.md index 7237391..4e45238 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,18 @@ Visualise a Git repository's commit history in PDF form via the command-line `pycairo` (used for deprecated PDF generation method, must be installed manually) ## Installation -**requires [pip](https://pip.pypa.io/en/stable/installation/)** +> [!IMPORTANT] +> Installing `commits2pdf` requires Python and pip. +> If you have Python installed without pip, click **[here](https://pip.pypa.io/en/stable/installation/)** to install it.

+> If you do not have Python installed, download the installer **[here](https://www.python.org/downloads/)**, then refer to the previous link on how to install pip.

+> Additionaly, `commits2pdf` requires Git for `gitpython` functionality. Install it **[here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)**. -> [!TIP] -> If using `python` or `pip` doesn't work, try using `python3` or `pip3` +> [!TIP] +> If using `python` or `pip` doesn't work, try using `python3` or `pip3`. - Make a virtual environment and activate it (recommended): -> [!IMPORTANT] -> Before you make a virtual environment, you should change your current directory to the folder of your repository. If you don't know how, read [Changing your terminal's directory](#changing-your-terminals-directory). + + - Before you make a virtual environment, you should change your current directory to the folder of your repository. If you don't know how, read [Changing your terminal's directory](#changing-your-terminals-directory). ``` pip install virtualenv python -m venv venv diff --git a/setup.py b/setup.py index 569905a..62fe10a 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setup( name="commits2pdf", - version="1.1.15", + version="1.1.16", author="Tomas Vana", url="https://github.com/tomasvana10/commits2pdf", description="Convert Git commits to a PDF",