Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
add alerts
  • Loading branch information
tomasvana10 authored May 20, 2024
1 parent 0a47af8 commit 0d0302b
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ Visualise a Git repository's commit history in PDF form via the command-line
## Installation
**requires [pip](https://pip.pypa.io/en/stable/installation/)**

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):
- 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).
> [!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).
```
pip install virtualenv
python -m venv venv
Expand All @@ -46,7 +48,8 @@ pip install --user -U commits2pdf
deactivate
```

**If you encounter errors with building `pycairo`, click [here](https://stackoverflow.com/a/76175684/23245953)**
> [!TIP]
> **If you encounter errors with building `pycairo`, click [here](https://stackoverflow.com/a/76175684/23245953)**
## Changing your terminal's directory
1. Open your terminal
Expand Down Expand Up @@ -111,7 +114,8 @@ There are many ways to configure the process of PDF generation through command l

## Usage

- Tip: If the value you are providing for a given argument/flag includes spaces, wrap in it quotations ("") to ensure it is parsed properly.
> [!TIP]
> If the value you are providing for a given argument/flag includes spaces, wrap in it quotations ("") to ensure it is parsed properly.
**Usage example #1**
```
Expand Down

0 comments on commit 0d0302b

Please sign in to comment.