Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme updates: formatting, links, and "how to hide your user@hostname" #57

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Readme updates: formatting, links, and "how to hide your user@hostname" #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand All @@ -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.
Expand Down