Skip to content

Commit 2d6ead4

Browse files
committed
docs(README): update documentation with improved descriptions and configuration details
1 parent 620dd9f commit 2d6ead4

2 files changed

Lines changed: 70 additions & 15 deletions

File tree

README.md

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Git Worktree Manager for VSCode
2+
# Git Worktree Manager
33

44
[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/jackiotyu.git-worktree-manager)](https://marketplace.visualstudio.com/items?itemName=jackiotyu.git-worktree-manager)
55
[![Open VSX Downloads](https://shields.io/open-vsx/dt/jackiotyu/git-worktree-manager)](https://open-vsx.org/extension/jackiotyu/git-worktree-manager)
@@ -10,7 +10,8 @@
1010

1111
English | [简体中文](./README.zh-CN.md)
1212

13-
Effortlessly manage Git worktrees in Visual Studio Code! 🚀 Simplify your workflow, work on multiple branches simultaneously, and boost productivity with this powerful extension.
13+
**Manage Git worktrees safely and efficiently inside Visual Studio Code.**
14+
Create, switch, and clean up worktrees without losing track of your branches.
1415

1516
<img src="./images/overview.png" width="800" />
1617

@@ -33,7 +34,11 @@ If you enjoy this extension, consider giving it a [star ⭐](https://github.com/
3334

3435
## Why Git Worktree Manager? 🌟
3536

36-
Tired of juggling branches, stashing changes, or resolving merge conflicts? **Git Worktree Manager** makes parallel development a breeze by leveraging Git worktrees, letting you work on multiple branches in separate directories without leaving VSCode. Whether you’re tackling hotfixes, experimenting with features, or managing complex projects, this extension saves time, reduces friction, and keeps your workspace organized. With seamless integration and intuitive controls, it’s the ultimate tool for developers who want a smoother Git experience.
37+
Git worktrees make parallel development cleaner by isolating branches into separate directories,
38+
but managing them manually can be tedious and error-prone.
39+
40+
Git Worktree Manager brings worktree management into VS Code,
41+
helping you create, switch, and clean up worktrees safely while keeping your repository organized.
3742

3843
<video src="./images/manage-multiple-repositories.mp4" controls="controls" width="800" height="450"></video>
3944
> [Manage multiple repositories effortlessly within VSCode.](./images/manage-multiple-repositories.mp4)
@@ -62,7 +67,7 @@ Tired of juggling branches, stashing changes, or resolving merge conflicts? **Gi
6267
- git version >= 2.40
6368

6469
1. **Install the Extension**:
65-
- Download from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=jackiotyu.git-worktree-manager).
70+
- Download from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=jackiotyu.git-worktree-manager) or [Open VSX Registry](https://open-vsx.org/extension/jackiotyu/git-worktree-manager).
6671
- Or search for "Git Worktree Manager" in VSCode’s Extensions view and install.
6772

6873
1. **Quick Start**:
@@ -78,10 +83,33 @@ Tired of juggling branches, stashing changes, or resolving merge conflicts? **Gi
7883

7984
## Configuration ⚙️
8085

81-
Customize your experience:
82-
- **`git-worktree-manager.treeView.toSCM`**: Display worktrees in the Source Control view.
83-
- **`terminal.external.windowsExec`**: Set your preferred terminal (e.g., `"C:\\Program Files\\Git\\bin\\bash.exe"` for Git Bash).
84-
- **`terminal.external.osxExec`**: Use iTerm or another terminal on macOS (e.g., `"iTerm.app"`).
86+
Customize Git Worktree Manager to fit your workflow:
87+
88+
- **`git-worktree-manager.treeView.toSCM`**
89+
Display worktrees in the Source Control view.
90+
91+
- **`git-worktree-manager.worktreeCopyPatterns`**
92+
Specify files or directories to be copied into a newly created worktree
93+
(for example, local config files or environment-specific assets).
94+
**Example:** `[".env.local", "config/*.json"]`
95+
96+
- **`git-worktree-manager.worktreeCopyIgnores`**
97+
Exclude specific files or paths from being copied when creating a worktree,
98+
even if they match `worktreeCopyPatterns`.
99+
**Example:** `["node_modules/**", "dist/**"]`
100+
101+
- **`git-worktree-manager.postCreateCmd`**
102+
Run a command automatically after a worktree is created
103+
(for example, installing dependencies or running setup scripts).
104+
**Example:** `"pnpm install"` or `"echo 'Worktree ready'"`
105+
106+
- **`terminal.external.windowsExec`**
107+
Set the external terminal on Windows
108+
(e.g. `"C:\\Program Files\\Git\\bin\\bash.exe"` for Git Bash).
109+
110+
- **`terminal.external.osxExec`**
111+
Set the external terminal on macOS
112+
(e.g. `"iTerm.app"`).
85113

86114
## Contributing 🤝
87115

README.zh-CN.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111

1212
简体中文 | [English](./README.md)
1313

14-
在 Visual Studio Code 中轻松管理 Git Worktree!🚀 简化工作流程,同时处理多个分支,提升生产力。这个扩展让 Git 管理变得更简单、更高效!
14+
**在 Visual Studio Code 中安全、高效地管理 Git worktree。**
15+
轻松创建、切换和清理 worktree,同时保持分支关系清晰可控。
1516

1617
<img src="./images/overview.png" width="800" />
1718

@@ -34,7 +35,11 @@
3435

3536
## 为什么选择 Git Worktree Manager?🌟
3637

37-
厌倦了频繁切换分支、暂存更改或解决合并冲突?**Git Worktree Manager** 通过 Git Worktree 功能,让您在不同目录中同时处理多个分支,无需离开 VSCode。无论是修复紧急问题、开发新功能还是管理复杂项目,这款扩展都能节省时间、减少麻烦,让您的工作区井然有序。凭借无缝集成和直观的操作,它是追求高效 Git 工作流的开发者的理想选择!
38+
Git worktree 可以将不同分支隔离在独立目录中,让并行开发更加清晰,
39+
但在命令行中手动管理这些 worktree 往往繁琐且容易出错。
40+
41+
Git Worktree Manager 将 worktree 管理能力直接集成到 VS Code 中,
42+
帮助你安全地创建、切换和清理 worktree,同时保持仓库结构清晰可控。
3843

3944
<video src="./images/manage-multiple-repositories.mp4" controls="controls" width="800" height="450"></video>
4045
> [在 VSCode 中轻松管理多个仓库。](./images/manage-multiple-repositories.mp4)
@@ -62,7 +67,7 @@
6267
- git version >= 2.40
6368

6469
1. **安装扩展**
65-
-[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=jackiotyu.git-worktree-manager) 下载。
70+
-[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=jackiotyu.git-worktree-manager) 或者 [Open VSX Registry](https://open-vsx.org/extension/jackiotyu/git-worktree-manager) 下载。
6671
- 或在 VSCode 扩展视图中搜索 "Git Worktree Manager" 并安装。
6772

6873
1. **快速开始**
@@ -78,10 +83,32 @@
7883

7984
## 配置 ⚙️
8085

81-
自定义您的体验:
82-
- **`git-worktree-manager.treeView.toSCM`**:在源代码管理视图中显示 Worktree。
83-
- **`terminal.external.windowsExec`**:设置首选终端(例如,Windows 的 Git Bash:`"C:\\Program Files\\Git\\bin\\bash.exe"`)。
84-
- **`terminal.external.osxExec`**:在 macOS 上使用 iTerm 等终端(例如,`"iTerm.app"`)。
86+
根据你的工作流程自定义 Git Worktree Manager:
87+
88+
- **`git-worktree-manager.treeView.toSCM`**
89+
在源码管理(Source Control)视图中显示 worktree。
90+
91+
- **`git-worktree-manager.worktreeCopyPatterns`**
92+
指定在创建新 worktree 时需要复制的文件或目录
93+
(例如本地配置文件或环境相关资源)。
94+
**示例:** `[".env.local", "config/*.json"]`
95+
96+
- **`git-worktree-manager.worktreeCopyIgnores`**
97+
在创建 worktree 时排除某些文件或路径,即使它们匹配 `worktreeCopyPatterns`
98+
**示例:** `["node_modules", "dist"]`
99+
100+
- **`git-worktree-manager.postCreateCmd`**
101+
在创建 worktree 后自动执行的命令
102+
(例如安装依赖或运行初始化脚本)。
103+
**示例:** `"pnpm install"``"echo 'Worktree 已就绪'"`
104+
105+
- **`terminal.external.windowsExec`**
106+
设置 Windows 系统下的外部终端
107+
(例如 Git Bash: `"C:\\Program Files\\Git\\bin\\bash.exe"`)。
108+
109+
- **`terminal.external.osxExec`**
110+
设置 macOS 系统下的外部终端
111+
(例如 iTerm: `"iTerm.app"`)。
85112

86113
## 贡献 🤝
87114

0 commit comments

Comments
 (0)