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   - 2 lines
  14   - Git intergration
  15   - Easily extensible
  16   - Bracketed sections
  17   - Vi-mode intergration
  18
  19 ## Name
  20 ```
  21 admon.e              V      2 1 PRES ACTIVE  IMP 2 S
  22 admoneo, admonere, admonui, admonitus  V (2nd) TRANS   [XXXAO]
  23 admonish, remind, prompt; suggest, advise, raise; persuade, urge; warn, caution
  24 ```
  25
  26 ## License
  27 Admone is MIT licensed
  28
  29 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)