README.md

   1 # admone
   2 A tolerable ZSH prompt
   3
   4 ![Screenshot](screenshot.png)
   5
   6 ## Installation
   7 Source this script somewhere in your ZSHRC. Theoretically works with plugin managers as well, although this is untested
   8
   9 ## Configuration
  10 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
  11
  12 ## My design requirements
  13   - No dependency on OhMyZSH
  14   - Quick to load
  15   - 2 lines
  16   - Git intergration
  17   - Easily extensible
  18   - Bracketed sections
  19   - Vi-mode intergration
  20
  21 ## Name
  22 ```
  23 admon.e              V      2 1 PRES ACTIVE  IMP 2 S
  24 admoneo, admonere, admonui, admonitus  V (2nd) TRANS   [XXXAO]
  25 admonish, remind, prompt; suggest, advise, raise; persuade, urge; warn, caution
  26 ```
  27
  28 ## License
  29 Admone is MIT licensed by Armaan Bhojwani
  30
  31 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)