diff --git a/README.md b/README.md index c5420ae..118c09d 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,18 @@ A shell coded in Python. No reason :) Just bored in class one day so I started to code this. Will have some basic commands in built, and as it is coded in Python you should be able to have a similar terminal experience anywhere! -**WARNING: Mash is currently unable to function on Windows! Any Unix-like OS should work fine.** +## So what even is Mash? -## What's currently working? +Mash is a shell (like sh, bash, fish, or zsh) which has been coded in Python by me. At the moment, Mash is still in a very early alpha stage. (As in it "works", but there's no guarantee that it *will* work.) There's a few built in commands (mls for ls, and mat for cat) to allow for higher consistency across different systems, but these are very basic (just use your system-bundled versions kind of basic). -`pwd`, `cat`, `cd`, `help`, `version` and `exit` (all without command line arguments) and commands with no arguments are working. The shell shows your current directory before the input prompt. +## Features +* Coded in Python, meaning you can quickly make a change to the code in real time +* Colourful out of the box +* Built in ls (mls) and cat (mat) +* Cross-platform (see below for details) -## What's planned? +## Platform support -Simple commands like `mkdir`, `touch` and `ls` should be added, maybe with some more advanced features later. +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. + +**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.