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 Jeffress 2024-07-15 17:52:12 +10:00
parent 16bdb47759
commit b7d080d4aa
1 changed files with 1 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -44,19 +44,4 @@ 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.
### Writing a config file
Mash will automatically look for a config file at `(home directory)/.config/mash/mash.conf`, and if one is not found, it will copy one from `/etc/mash/mash.conf`. If neither of these exist, it crashes (for now). The syntax isn't that hard to understand, but may change in the future if I feel like it.
To write a valid line of Mash syntax, type:
`thingToConfigure:configurationOption,`
Mash looks for a colon in every word, and if it is found, that is recognised as an option for configuration. **For now, don't type a space between the colon and the next option.** After your custom option, the comma is used to signal the end of configuring that option. You can either start typing on a new line, or type **without a space** after the comma.
### Valid configuration options
* `motd:(string),`: Set your MOTD when opening Mash.
* `mashPath:/bin;/usr/bin`: Set directories in Mash's path
More should be added in future.
Read more at https://git.maxwellj.xyz/max/mash/wiki/Configuration