Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xbais authored Nov 1, 2024
1 parent edbb538 commit d659c8c
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,5 @@
```

## 🔷 Installation & Usage
1. Install MiniMark : (in Ubuntu < 24.04 LTS) `pip3 install minimark`, (in Ubuntu 24.04 LTS) `pip3 install minimark --break-system-packages` (NOTE : Ubuntu 24 does not allow installing any python packages without the additional flag, but rest assured : IT IS SAFE, if you dont want this, you can install Minimark in a separate Python venv)
2. Create Alias for MiniMark : add the following line at the end of your `~/.bashrc` file (if you use Bash), or your `~/.zshrc` file (if you use ZSH) : `alias minimark='python3 -m minimark'`
Now, you can run MiniMark using the terminal command : `minimark` !! Enjoy!

NOTE:
- If you dont want to create an alias, you can still run MiniMark using the command : `python3 -m minimark`
- For Ubuntu < 24.04 LTS : `pip3 install minimark`
- For Ubuntu == 24.04 LTS : `pip3 install minimark --break-system-packages` (NOTE : Ubuntu 24 does not allow installing any python packages without the additional flag, but rest assured : IT IS SAFE, if you dont want this, you can install Minimark in a separate Python venv)

0 comments on commit d659c8c

Please sign in to comment.