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

Add install instructions

Browse Source
This commit is contained in:
Maxwell Jeffress 2024-07-15 09:41:16 +10:00
parent f891a5148e
commit 0703cfc3dc
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -9,6 +9,7 @@ Just bored in class one day so I started to code this. Will have some basic comm
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). 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).
## Features ## Features
* Coded in Python, meaning you can quickly make a change to the code in real time * Coded in Python, meaning you can quickly make a change to the code in real time
* Colourful out of the box * Colourful out of the box
* Built in ls (mls) and cat (mat) * Built in ls (mls) and cat (mat)
@ -21,6 +22,18 @@ Mash has been developed and tested on Arch Linux (btw), so should work as intend
**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. **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.
## Setup
If you decide for whatever reason you would like to use Mash, here's some steps:
1. Clone the repo
2. Create the files .history.mash and .config/mash/mash.conf
3. Make sure `colorama` is installed, as this is what currently provides the colours for Mash.
4. Run main.py
## Configuration (EARLY BETA) ## Configuration (EARLY BETA)
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. 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.