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