max/mash
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects 2 Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Maxwell
2024-07-15 12:45:31 +10:00
parent 4cef1f1920
commit f89f5150f8
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -24,13 +24,19 @@ Mash has been developed and tested on Arch Linux (btw), so should work as intend
## Setup ## Setup
If you decide for whatever reason you would like to use Mash, here's some steps: ### Quick Setup
Copy this command into a terminal (so long as Bash is installed) `sudo curl https://maxwellj.xyz/mash/install.sh | bash`
Make sure `colorama` is installed with Pip or your distro's package manager (usually as python-colorama), as this is what currently provides the colours for Mash. This should be changed in future.
### Manual Setup
1. Clone the repo 1. Clone the repo
2. Create the files .history.mash and .config/mash/mash.conf 2. Create the files .history.mash and .config/mash/mash.conf, and add configurations to your config file
3. Make sure `colorama` is installed, as this is what currently provides the colours for Mash. 3. Make sure `colorama` is installed with Pip or your distro's package manager (usually as python-colorama), as this is what currently provides the colours for Mash.
4. Run main.py 4. Run main.py