diff options
Diffstat (limited to 'doc/README_CN.md')
| -rw-r--r-- | doc/README_CN.md | 78 |
1 files changed, 56 insertions, 22 deletions
diff --git a/doc/README_CN.md b/doc/README_CN.md index 433aaec..2088e78 100644 --- a/doc/README_CN.md +++ b/doc/README_CN.md @@ -14,50 +14,85 @@ | | ____ | | | | | ___ | | | \_ ) | | | | | ( ) | | (___) |__) (___ | | | ) ( | -(_______)_______/ )_( |/ \| v0.10 +(_______)_______/ )_( |/ \| v0.16 ``` # Gita：一个管理多个 git 库的命令行工具 -这个工具有两个作用： +这个工具有两个功能: - 并排显示多个库的状态信息，比如分支名，编辑状态，提交信息等 - 在任何目录下（批处理）代理执行 git 指令  -本地和远程分支之间的关系有5种情况，在这里分别用5种颜色对应着： +在这个截屏里,`gita ll`显示所有库的状态信息,`gita remote dotfiles`等价于在 +`dotfiles`库里运行`git remote -v`,`gita fetch`对所有库做`fetch`操作,在这个例子 +里,两个库有更新. -- 绿色：本地和远程保持一致 -- 红色：本地和远程产生了分叉 -- 黄色：本地落后于远程（适合合并merge） -- 白色：本地没有指定远程 -- 紫色：本地超前于远程（适合推送push） +本地和远程分支之间的5种关系分别用5种颜色对应： -为什么选择了紫色作为超前以及黄色作为落后，绿色作为基准 的理由在这两篇文章中解释： -[blueshift](https://en.wikipedia.org/wiki/Blueshift)、[redshift](https://en.wikipedia.org/wiki/Redshift) +颜色|含义 +----|---- + 绿色|本地和远程保持一致 + 红色|本地和远程产生了分叉 + 黄色|本地落后于远程（适合合并merge） + 白色|本地没有指定远程 + 紫色|本地超前于远程（适合推送push） + +紫色作为超前,黄色作为落后，绿色作为基准的理由取自蓝移和红移： +[blueshift](https://en.wikipedia.org/wiki/Blueshift)、[redshift](https://en.wikipedia.org/wiki/Redshift). 额外的状态符号意义： - `+`: 暂存(staged) -- `*`： 未暂存（unstaged） -- `_`： 未追踪（untracked） +- `*`: 未暂存（unstaged） +- `?`: 未追踪（untracked） 基础指令： - `gita add <repo-path(s)>`: 添加库 -- `gita rm <repo-name(s)>`: 移除库（不会删除文件） -- `gita group`: 显示库的组群 -- `gita group` <repo-name(s)>: 将库分组 +- `gita add -a <repo-parent-path(s)>`: 递归添加路径下的所有库并自动产生层级分组,见 + [customization section](#custom) +- `gita add -b <bare-repo-path(s)>`: 添加bare库 + [customization section](#custom) +- `gita add -r <repo-parent-path(s)>`: 递归添加路径下的所有库 +- `gita clear`: +- `gita clone <URL>`: +- `gita clone <URL> -C <directory>`: +- `gita clone -f <config-file>`: 克隆`<config-file>` (由`gita freeze`生成)里的库 +- `gita clone -p -f <config-file>`: 克隆`<config-file>`里的库并放到指定路径 +- `gita context`: 情境命令 + - `gita context`: 显示当前的情境 + - `gita context none`: 去除情境 + - `gita context <group-name>`: 把情境设置成`group-name`, 之后所有的操作只作用到这个组里的库 +- `gita color`: + - `gita color [ll]`:显示颜色设置 + - `gita color set <situation> <color>`:给本地/远程关系设置颜色 +- `gita flags`: + - `gita flags set <repo-name> <flags>`:给库设置flags + - `gita flags [ll]`:显示已有的flags +- `gita freeze`:显示URL, 路径之类的库信息(配合`gita clone`使用) +- `gita group`: 组群命令 + - `gita group add <repo-name(s)>`: 把库加入新的或者已经存在的组 + - `gita group [ll]`: 显示已有的组和它们的库 + - `gita group ls`: 显示已有的组名 + - `gita group rename <group-name> <new-name>`: 改组名 + - `gita group rm group(s): 删除组 + - `gita group rmrepo -n <group-name>:删除组里的库 +- `gita info`: 显示已用的和未用的信息项 + - `gita info [ll]` + - `gita info add <info-item>` + - `gita info rm <info-item>` - `gita ll`: 显示所有库的状态信息 - `gita ll <group-name>`: 显示一个组群中库的状态信息 - `gita ls`: 显示所有库的名字 - `gita ls <repo-name>`: 显示一个库的绝对路径 - `gita rename <repo-name> <new-name>`: 重命名一个库 -- `gita info`: 显示已用的和未用的信息项 +- `gita rm <repo-name(s)>`: 移除库（不会删除文件） - `gita -v`: 显示版本号 -库的路径存在`$XDG_CONFIG_HOME/gita/repo_path` (多半是`~/.config/gita/repo_path`)。 +库的路径存在`$XDG_CONFIG_HOME/gita/repos.csv` (多半是`~/.config/gita/repos.csv`)。 代理执行的子命令有两种格式： @@ -72,7 +107,7 @@ ## 安装指南 -正常人类按装： +正常人类安装： ``` pip3 install -U gita @@ -142,11 +177,10 @@ comaster: help: checkout the master branch ``` 另一个自定义功能是针对`gita ll`展示的信息项。 -`gita info`可以展示所有用到的和没用到的信息项，并且可以通过修改`$XDG_CONFIG_HOME/gita/info.yml`支持自定义。举个栗子，默认的信息项显示配置相当于是： +`gita info`可以展示所有用到的和没用到的信息项，并且可以通过修改`$XDG_CONFIG_HOME/gita/info.csv`支持自定义。举个栗子，默认的信息项显示配置相当于是： -```yaml -- branch -- commit_msg +```csv +branch,commit_msg,commit_time ``` 为了创建自己的信息项，命名一个目录为`extra_info_items`。 在`$XDG_CONFIG_HOME/gita/extra_repo_info.py`中，要把信息项的名字作为字符串映射到方法中，该方法将库的路径作为输入参数。举个栗子： |