diff --git a/README.md b/README.md index 9776862..899a121 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,19 @@ Mash has been developed and tested on Arch Linux (btw), so should work as intend ## 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 -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