diff --git a/README.md b/README.md index 1e328ef..90f4f18 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Mash is a shell (like sh, bash, fish, or zsh) which has been coded in Python by ## Platform support -Mash has been developed and tested on Arch Linux (btw), so should work as intended there. However, Mash should run anywhere so long as there is a UNIX-like filesystem, a recent version of Python 3 is installed and the `colorama` Pip package is avaliable (providing the colours). This means macOS, most Linux distros, and most UNIX-like OSes should work without too much modification. +Mash has been developed and tested on Arch Linux (btw), so should work as intended there. However, Mash should run anywhere so long as there is a UNIX-like filesystem, and a recent version of Python 3 is installed. This means macOS, most Linux distros, and most UNIX-like OSes should work without too much modification. **However, Windows support is very hit and miss. Don't see this as a Powershell replacement.** Yes, I know Powershell and the regular Command Prompt suck, but for now don't expect good support. Running programs is tested and working, however using directories gets a bit messy due to the differences between UNIX-like and NT design. @@ -28,16 +28,12 @@ Mash has been developed and tested on Arch Linux (btw), so should work as intend Copy this command into a terminal (so long as Bash is installed) `curl https://maxwellj.xyz/mash/install.sh | sudo 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, and add configurations to your config file -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 ## Configuration (EARLY BETA) @@ -45,3 +41,41 @@ Make sure `colorama` is installed with Pip or your distro's package manager (usu Mash is a "configurable" shell. You can customise some parts of it to make it your own. It uses a syntax that is sort of inspired by CSS (emphasis on the sort of), but I just coded whatever felt easiest to code. Read more at https://git.maxwellj.xyz/max/mash/wiki/Configuration + +## Fun platforms Mash can run on (for no reason) + +### Mac OS X 10.6 + +* Working? **Yes** + +* Workarounds needed? **Install Python 3.12 through MacPorts** + +* Issues? **None** + +* Script install? **No** + +* Practical? **Not really** + +### Haiku + +* Working? **Yes** + +* Workarounds needed? **Manually put the config file in required location** + +* Issues? **None** + +* Script install? **No** + +* Practical? **Yes** + +### Grok Learning + +* Working? **Yes** + +* Workarounds needed? **Manually set the user variable in Mash, manually set config** + +* Issues? **There are limits set by Grok** + +* Script install? **No** + +* Practical? **No** \ No newline at end of file