X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=860acd9146aab3f990547a5cf8fcd050cd63e904;hb=b84abe4590bfdc002f131cc183caec0316861942;hp=72b1e40d575eb39e36a6a827187e42c97dae4d33;hpb=a49ca0e8dd33182fdd57a8aa05d1dea6ab003329;p=admone.git diff --git a/README.md b/README.md index 72b1e40..860acd9 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,22 @@ # admone -A tolerable ZSH prompt +A tolerable Zsh prompt + +![Screenshot](branding/screenshot.png) ## Installation -Source this script somewhere in your ZSHRC -Theoretically works with plugin managers as well although this is untested +Source this script somewhere in your Zshrc. Theoretically works with plugin managers as well, although this is untested + +## Configuration +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 -## Requirements - - No OhMyZSH dependency - - Fast to load +## My design requirements + - No dependency on OhMyZSH + - Quick to load - 2 lines - - Git intergration + - Git integration - Easily extensible - Bracketed sections - - Vi-mode intergration + - Vi-mode integration ## Name ``` @@ -22,6 +26,6 @@ admonish, remind, prompt; suggest, advise, raise; persuade, urge; warn, caution ``` ## License -Admone is MIT licensed +Admone is MIT licensed by [Armaan Bhojwani](https://armaanb.net), [email](mailto:code@armaanb.net) -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) +Code is heavily inspired by [Pierre-Albéric TROUPLIN's prompt](https://github.com/palb91/dotfiles/blob/master/zsh/conf.d/00_prompt.zsh), [this gist by romkatv](https://gist.github.com/romkatv/2a107ef9314f0d5f76563725b42f7cab), and [this comment by romkatv](https://github.com/romkatv/powerlevel10k/issues/888#issuecomment-657969840)