Skip to content

Commit 9a9713d

Browse files
authored
Merge pull request #19 from SkwalExe/readme
update installtion instructions in readme
2 parents b4f667b + 8676c86 commit 9a9713d

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,35 @@ I had the idea to create this project after seeing the logos made by [adi1090x](
1919

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

22-
# Usage
22+
# How to install 📥
2323

24-
First, clone this repository
24+
You can install octologo easily with pip:
2525

2626
```bash
27-
git clone https://github.com/SkwalExe/octo-logo
28-
cd octo-logo
27+
python3 -m pip install octologo
2928
```
3029

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

3332
```bash
34-
pip3 install -r requirements.txt
33+
pipx install octologo
3534
```
3635

37-
And finally, launch the program and follow the instructions
36+
Now, start the app with:
3837

3938
```bash
40-
python3 src/main.py
39+
octologo
40+
```
41+
42+
> [!CAUTION]
43+
> 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.
44+
45+
```bash
46+
# For bash
47+
echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc
48+
49+
# For zsh
50+
echo 'export PATH=$PATH:~/.local/bin' >> ~/.zshrc
4151
```
4252

4353
# Styles

0 commit comments

Comments
 (0)