diff --git a/README.md b/README.md index cfaec07..cc78f12 100644 --- a/README.md +++ b/README.md @@ -2,70 +2,84 @@ ## Overview -An oh-my-zsh theme; -![demo.png](./demo/demo.png) +An oh-my-zsh theme. -### Feature +![demo.png](./reademe/demo.png) -- Real Time Prompt -- Displays Command Running Time -- Command Execution Error Hint +### Features + +You can see the followings at once: + +- Real Time +- Login User +- Working Directory +- Anaconda's Environment Name - Rich Git Status +After command execution, you can see also: + +- Command Execution Time +- Success/Error Hint + ## Install -### Basic Install - -1. Clone Repository: - -```shell -git clone https://github.com/philip82148/simplerich-zsh-theme -``` - -2. Copy Theme: +1. Clone Repo & Copy Theme. ```shell +# cd path/to/where_u_want_to_clone_the_repo +git clone --recursive https://github.com/philip82148/simplerich-zsh-theme cp ./simplerich-zsh-theme/simplerich.zsh-theme ~/.oh-my-zsh/themes/ ``` -3. Edit ~/.zshrc: +2. Edit ~/.zshrc. -```shell:~/.zshrc -# Find the line that reads ZSH_THEME="..." and replace it with the following code. +```shell +# file:~/.zshrc +# Find the line that reads ZSH_THEME="..." and replace it with the followings. ZSH_THEME="simplerich" +source path/to/where_u_want_to_clone_the_repo/simplerich-zsh-theme/zsh-git-prompt/zshrc.sh ``` -4. Load ~/.zshrc: +**Attention** + +- These must be BEFORE the line `source $ZSH/oh-my-zsh.sh` in `~/.zshrc`. +- Change the path of `source .../zsh-git-prompt/zshrc.sh` according to your environment. +- If you comment out `source .../zsh-git-prompt/zshrc.sh` or you cannot use `python` command, you can use a simpler git status like the following: + ![simpler-git-status.png](./reademe/simpler-git-status.png) + +1. Load ~/.zshrc. ```shell source ~/.zshrc ``` -- See Also: [Overriding and adding themes](https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-themes); +See Also: [Overriding and adding themes](https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-themes), [zsh-git-prompt](https://github.com/olivierverdier/zsh-git-prompt) ## Trouble Shooting -### macOS, command not found: gdate +### On macOS, Command Not Found: gdate -- simplerich.zsh-theme depends on cmd `gdate` to get current time in milliseconds. get `gdate` on macOS by running `brew install coreutils` then `source ~/.zshrc`; -- See Also: [#12](https://github.com/ChesterYue/ohmyzsh-theme-passion/issues/12); +- simplerich.zsh-theme depends on cmd `gdate` to get current time in milliseconds. get `gdate` on macOS by running `brew install coreutils` then `source ~/.zshrc`. +- See also [#12](https://github.com/ChesterYue/ohmyzsh-theme-passion/issues/12). -### Linux, command not found: bc +### On Linux, Command Not Found: bc -- simplerich.zsh-theme depends on cmd `bc` to calculate the command running time cost. [get bc on Linux](https://www.tecmint.com/bc-command-examples/#:~:text=If%20you%20don%E2%80%99t%20have%20bc%20on%20your%20system%2C,command%20prompt%20and%20simply%20start%20calculating%20your%20expressions.) then `source ~/.zshrc`; -- see also: [#13](https://github.com/ChesterYue/ohmyzsh-theme-passion/issues/13); +- simplerich.zsh-theme depends on cmd `bc` to calculate the command running time cost. [get bc on Linux](https://www.tecmint.com/bc-command-examples/#:~:text=If%20you%20don%E2%80%99t%20have%20bc%20on%20your%20system%2C,command%20prompt%20and%20simply%20start%20calculating%20your%20expressions.) then `source ~/.zshrc`. +- See also [#13](https://github.com/ChesterYue/ohmyzsh-theme-passion/issues/13). -### Centos 7, shell exit +### On Centos 7, Shell Exit -- may caused by [set timer to zsh prompt](https://github.com/ChesterYue/ohmyzsh-theme-passion/blob/8f71c43c2df91810249ab00ff40fc4ca63207467/passion.zsh-theme#L197-L208); -- see also: [#4](https://github.com/ChesterYue/ohmyzsh-theme-passion/issues/4); +- It may be caused by [set timer to zsh prompt](https://github.com/ChesterYue/ohmyzsh-theme-passion/blob/8f71c43c2df91810249ab00ff40fc4ca63207467/passion.zsh-theme#L197-L208). +- See also [#4](https://github.com/ChesterYue/ohmyzsh-theme-passion/issues/4). ## Extra Preferences ### Zsh Plugins -1. [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions); -2. [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting); +1. [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) +2. [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) +3. [zsh-completions](https://github.com/zsh-users/zsh-completions) +4. [zsh-history-substring-search](https://github.com/zsh-users/zsh-history-substring-search) ### iTerm2 Preferences @@ -73,14 +87,17 @@ source ~/.zshrc -- iTerm2: settings -> Profiles -> Colors -> Color Presets -> import `./simplerich.itermcolors` ![color.png](./image/color.png) -- alternate terminal: try [Alternate terminal installation and configuration](https://iterm2colorschemes.com/); +- iTerm2: Settings -> Profiles -> Colors -> Color Presets -> Import `./simplerich.itermcolors` + ![color.png](./reademe/color.png) +- Alternate terminal: Try [Alternate terminal installation and configuration](https://iterm2colorschemes.com/). #### Status Bar -- iTerm2: settings -> Appearance && settings -> Profiles -> Session -> Configure Status Bar ![status_0.png](./image/status_0.png) ![status_1.png](./image/status_1.png) +- iTerm2: Settings -> Appearance && settings -> Profiles -> Session -> Configure Status Bar + ![status_0.png](./reademe/status_0.png) ![status_1.png](./reademe/status_1.png) #### Font -- install [JetBrains Mono](https://www.jetbrains.com/lp/mono/); -- iTerm2: settings -> Appearance && settings -> Profiles -> Text -> Font ![font.png](./image/font.png) +- Install [JetBrains Mono](https://www.jetbrains.com/lp/mono/). +- iTerm2: Settings -> Appearance && settings -> Profiles -> Text -> Font + ![font.png](./reademe/font.png) diff --git a/demo/README.md b/demo/README.md deleted file mode 100644 index 7e7cff4..0000000 --- a/demo/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# demo - -## warning - -make sure image refed by [External-themes](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes) exist; - -## iTerm title - -Settings - Profiles - Window - Custom tab title - ohmyzsh-theme-passion - -## cmd - -``` shell -# mkdir demo; cd demo; mkdir demo-git; cd demo-git; git init; -# git config --local user.name / user.email ... -# cd .. - -echo real time prompt -echo command running time cost prompt -test command running error hint - -cd demo-git -echo git status prompt -touch test.txt -git st -git add -A -git ci -m "test" - -# enter twice -``` diff --git a/demo/demo.png b/demo/demo.png deleted file mode 100644 index 5cd08d4..0000000 Binary files a/demo/demo.png and /dev/null differ diff --git a/image/color.png b/reademe/color.png similarity index 100% rename from image/color.png rename to reademe/color.png diff --git a/reademe/demo.png b/reademe/demo.png new file mode 100644 index 0000000..0e021a0 Binary files /dev/null and b/reademe/demo.png differ diff --git a/image/font.png b/reademe/font.png similarity index 100% rename from image/font.png rename to reademe/font.png diff --git a/reademe/simpler-git-status.png b/reademe/simpler-git-status.png new file mode 100644 index 0000000..f28334f Binary files /dev/null and b/reademe/simpler-git-status.png differ diff --git a/image/status_0.png b/reademe/status_0.png similarity index 100% rename from image/status_0.png rename to reademe/status_0.png diff --git a/image/status_1.png b/reademe/status_1.png similarity index 100% rename from image/status_1.png rename to reademe/status_1.png