chore(release): 发布 0.9.0 版本并更新路线图
This commit is contained in:
29
readme_zh.md
29
readme_zh.md
@@ -14,6 +14,7 @@
|
||||
|
||||
## 主要功能
|
||||
|
||||
- **仓库初始化**:用 `quicommit ginit` 一键起步本地 Git 仓库——建库、写最简 `README.md`、按识别出的生态生成 `.gitignore`、确立初始分支、添加远程。全程离线,不创建首个提交
|
||||
- **AI智能生成**:使用LLM API(Ollama本地、OpenAI、Anthropic Claude、Kimi、DeepSeek、OpenRouter)生成提交信息、标签和变更日志
|
||||
- **规范化提交**:支持Conventional Commits和commitlint格式规范
|
||||
- **多配置管理**:为不同场景管理多个Git身份,支持SSH密钥和GPG签名配置
|
||||
@@ -47,6 +48,28 @@ cargo install --path .
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 初始化 Git 仓库
|
||||
|
||||
```bash
|
||||
# 把当前目录初始化为 Git 仓库
|
||||
quicommit ginit
|
||||
|
||||
# 指定初始分支(默认取全局 init.defaultBranch,缺省为 main)
|
||||
quicommit ginit -b dev
|
||||
|
||||
# 添加远程,可重复传入:--add <URL> 或 --add <名称>=<URL>
|
||||
quicommit ginit --add https://github.com/user/repo.git
|
||||
quicommit ginit --add upstream=git@github.com:user/repo.git
|
||||
|
||||
# 把已有 Git 配置套用到新仓库
|
||||
quicommit ginit --profile work
|
||||
|
||||
# 只预览,不写任何内容
|
||||
quicommit ginit --dry-run
|
||||
```
|
||||
|
||||
`ginit` 全程离线且可重复执行:不创建首个提交,也不覆盖已存在的 `README.md` 与 `.gitignore`。
|
||||
|
||||
### 初始化配置
|
||||
|
||||
```bash
|
||||
@@ -384,6 +407,8 @@ quicommit config reset --force
|
||||
|
||||
## 配置文件
|
||||
|
||||
> 完整的分类配置说明(快速设置、逐字段详解、provider 默认值、常见配方与故障排除)见 [docs/configuration-guide.md](docs/configuration-guide.md)。
|
||||
|
||||
配置文件位置:
|
||||
- Linux: `~/.config/quicommit/config.toml`
|
||||
- macOS: `~/Library/Application Support/quicommit/config.toml`
|
||||
@@ -558,6 +583,7 @@ src/
|
||||
│ ├── changelog.rs
|
||||
│ ├── profile.rs
|
||||
│ ├── config.rs
|
||||
│ ├── ginit.rs
|
||||
│ └── init.rs
|
||||
├── config/ # 配置管理
|
||||
│ ├── manager.rs
|
||||
@@ -566,7 +592,8 @@ src/
|
||||
├── git/ # Git操作封装
|
||||
│ ├── commit.rs
|
||||
│ ├── tag.rs
|
||||
│ └── changelog.rs
|
||||
│ ├── changelog.rs
|
||||
│ └── init.rs
|
||||
├── llm/ # LLM 集成(基于 rig-core)
|
||||
│ ├── mod.rs
|
||||
│ ├── prompts.rs
|
||||
|
||||
Reference in New Issue
Block a user