Skip to content

Commit

Permalink
update installtion instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SkwalExe committed Jun 1, 2024
1 parent b4f667b commit 8676c86
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,35 @@ I had the idea to create this project after seeing the logos made by [adi1090x](

- [adi1090x's GitHub](https://github.com/adi1090x)

# Usage
# How to install 📥

First, clone this repository
You can install octologo easily with pip:

```bash
git clone https://github.com/SkwalExe/octo-logo
cd octo-logo
python3 -m pip install octologo
```

Then, install the dependencies
You can also use [pipx](https://pypa.github.io/pipx/):

```bash
pip3 install -r requirements.txt
pipx install octologo
```

And finally, launch the program and follow the instructions
Now, start the app with:

```bash
python3 src/main.py
octologo
```

> [!CAUTION]
> If the command is not found after installtion, you must add `~/.local/bin` to your path. You can do this by adding `export PATH=$PATH:~/.local/bin` to your `.bashrc` or `.zshrc` file.
```bash
# For bash
echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc

# For zsh
echo 'export PATH=$PATH:~/.local/bin' >> ~/.zshrc
```

# Styles
Expand Down

0 comments on commit 8676c86

Please sign in to comment.