diff --git a/README.md b/README.md index a45667e4..4b0315e2 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ A ZSH theme optimized for people who use: - Solarized - Git -- Unicode-compatible fonts and terminals (I use iTerm2 + Menlo) +- Unicode-compatible fonts and terminals (I use [iTerm2](https://www.iterm2.com/) + Menlo) -For Mac users, I highly recommend iTerm 2 + Solarized Dark +For Mac users, I highly recommend [iTerm2](https://www.iterm2.com/) + Solarized Dark # Compatibility -**NOTE:** In all likelihood, you will need to install a [Powerline-patched font](https://github.com/Lokaltog/powerline-fonts) for this theme to render correctly. +**NOTE:** In all likelihood, you will need to install a [Powerline-patched font](https://github.com/powerline/fonts) for this theme to render correctly. To test if your terminal and font support it, check that all the necessary characters are supported by copying the following command to your terminal: `echo "\ue0b0 \u00b1 \ue0a0 \u27a6 \u2718 \u26a1 \u2699"`. The result should look like this: @@ -19,7 +19,7 @@ To test if your terminal and font support it, check that all the necessary chara ## What does it show? - If the previous command failed (✘) -- User @ Hostname (if user is not DEFAULT_USER, which can then be set in your profile) +- User @ Hostname (if user is not `DEFAULT_USER`, which can then be set in your profile) - Git status - Branch () or detached head (➦) - Current branch / SHA1 in detached head state @@ -29,6 +29,9 @@ To test if your terminal and font support it, check that all the necessary chara ![Screenshot](https://gist.githubusercontent.com/agnoster/3712874/raw/screenshot.png) +## Hiding your user@hostname +Optionally set `DEFAULT_USER` to your regular username followed by `prompt_context(){}` in `~/.zshrc` to hide the "user@hostname" info when you’re logged in as yourself on your local machine. + ## Future Work I don't want to clutter it up too much, but I am toying with the idea of adding RVM (ruby version) and n (node.js version) display.