From 6081ea575222dc453969b70723245456de75eb00 Mon Sep 17 00:00:00 2001 From: philip82148 <92205270+philip82148@users.noreply.github.com> Date: Mon, 25 Sep 2023 12:10:25 +0900 Subject: [PATCH] add 'Git Status Symbols' section --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 530ca48..015e9c4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Overview -An oh-my-zsh theme. +simplerich-zsh-theme is an oh-my-zsh theme. ![demo.png](./readme/demo.png) @@ -21,9 +21,23 @@ After command execution, you can see also: - Command Execution Time - Success/Error Hint +## Git Status Symbols + +The git status is updated immediately after a command is finished or every 10 seconds after the terminal is started. + +| Symbol | Meaning | +| ------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `[main]` | The repository is clean. | +| `[main +n]` | There are n staged files. | +| `[main ●n]` | There are n changed but unstaged files. | +| `[main …n]` | There are n untracked files. | +| `[main xn]` | There are n conflicting files. | +| `[main n\|m]` | The local branch is m commits ahead and n commits behind the remote branch. | +| `[main *]` | This will be displayed instead of the informative symbols
when python cannot be executed and the repository not clean. | + ## Install -1. Clone Repo & Copy Theme. +1. Clone the repository & copy the zsh-theme file. ```shell # cd path/to/where_u_want_to_clone_the_repo