Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
Signed-off-by: jackiotyu <[email protected]>
  • Loading branch information
jackiotyu committed Oct 23, 2023
1 parent be987bf commit a9f457d
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@
This extension aims to provide convenient switching between multiple workspaces, facilitate shared Git commit information, and support running code simultaneously in different directories.
该扩展旨在提供便捷的多工作区切换功能,并实现共享 Git 提交信息,同时支持在不同目录上同时运行代码。

[![Product Name Screen Shot][product-screenshot]](https://github.com/jackiotyu/git-worktree-manager)
![ git worktree manager preview](images/preview.gif)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<details>
<summary>Overview 概览</summary>
<img src="https://cdn.jsdelivr.net/gh/jackiotyu/[email protected]/images/overview.png" height="500" width="800" />
</details>

<details>
<summary>How Git Worktree Works. git worktree 工作原理</summary>
<section>
Expand Down Expand Up @@ -55,10 +60,8 @@ In summary, git worktree provides a flexible way to manage multiple tasks or ver
</details>



<!-- GETTING STARTED -->
## Getting Started
## 快速开始
## Getting Started 快速开始

1. Install the extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=jackiotyu.git-worktree-manager).
在VSCode[扩展市场](https://marketplace.visualstudio.com/items?itemName=jackiotyu.git-worktree-manager)中安装
Expand All @@ -67,18 +70,16 @@ In summary, git worktree provides a flexible way to manage multiple tasks or ver
1. Performing various quick operations of git worktree on the panel
在面板上执行各种 git worktree 快速操作

### Requirements
### 要求
### Requirements 要求

* git version >= 2.30 for best performance.
* 建议安装版本号不低于2.30的git

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->
## Usage
## Usage 使用

1. Worktree manager. 管理 worktree

Expand All @@ -87,6 +88,7 @@ In summary, git worktree provides a flexible way to manage multiple tasks or ver
点击 `添加 worktree` 图标,跟随提示进行操作,添加新的 worktree。
- It provides some useful command in context menu. You can open a new window for a worktree when click worktree item.
右键上下文菜单中提供了一下方便的命令。可以点击 worktree 项直接在新窗口打开 worktree。
![open-terminal](images/open-terminal.png)
- Using VSCode built-in external terminal. It can configure by setting `terminal.external.windowsExec` in windows, other platforms is similar.
使用 VSCode 自带的外部终端设置。在 windows 上可以通过 `terminal.external.windowsExec` 配置启用的终端,其他平台类似。
```json
Expand All @@ -95,6 +97,7 @@ In summary, git worktree provides a flexible way to manage multiple tasks or ver
"terminal.external.windowsExec": "C:\\Program Files\\Git\\bin\\bash.exe",
}
```
![pull-commit](images/pull-commit.png)
- Quick pull/push commits in remote branch.
快速在远程分支上pull/push提交。
- Quick view git history. (current use extension [mhutchie.git-graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph))
Expand Down
Binary file added images/open-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/overview.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/pull-commit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a9f457d

Please sign in to comment.