]> git.armaanb.net Git - admone.git/blob - README.md
72b1e40d575eb39e36a6a827187e42c97dae4d33
[admone.git] / README.md
1 # admone
2 A tolerable ZSH prompt
3
4 ## Installation
5 Source this script somewhere in your ZSHRC
6 Theoretically works with plugin managers as well although this is untested
7
8 ## Requirements
9   - No OhMyZSH dependency
10   - Fast to load
11   - 2 lines
12   - Git intergration
13   - Easily extensible
14   - Bracketed sections
15   - Vi-mode intergration
16
17 ## Name
18 ```
19 admon.e              V      2 1 PRES ACTIVE  IMP 2 S    
20 admoneo, admonere, admonui, admonitus  V (2nd) TRANS   [XXXAO]  
21 admonish, remind, prompt; suggest, advise, raise; persuade, urge; warn, caution
22 ```
23
24 ## License
25 Admone is MIT licensed
26
27 The code is inspired by [palb91's prompt](https://github.com/palb91/dotfiles/blob/master/zsh/conf.d/00_prompt.zsh) and [this gist by romkatv](https://gist.github.com/romkatv/2a107ef9314f0d5f76563725b42f7cab)