]> git.armaanb.net Git - admone.git/blob - README.md
Combine VCS and PWD
[admone.git] / README.md
1 # admone
2 A tolerable Zsh prompt
3
4 ## Installation
5 Source this script somewhere in your Zshrc. Theoretically works with plugin managers as well, although this is untested
6
7 ## Configuration
8 Configuration is done by modifying the variables set at the start of the script. Just get in there and mess around a bit, its not very difficult to understand
9
10 ## My design requirements
11   - No dependency on OhMyZSH
12   - Quick to load
13   - Git integration
14   - Easily extensible
15   - Bracketed sections
16   - Vi-mode integration
17
18 ## Name
19 ```
20 admon.e              V      2 1 PRES ACTIVE  IMP 2 S    
21 admoneo, admonere, admonui, admonitus  V (2nd) TRANS   [XXXAO]  
22 admonish, remind, prompt; suggest, advise, raise; persuade, urge; warn, caution
23 ```
24
25 ## License
26 Admone is MIT licensed by [Armaan Bhojwani](https://armaanb.net), 2021.