Skip to content

Commit 0952d89

Browse files
author
lu0
committed
Reorganize README.
1 parent 971603a commit 0952d89

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@ Table of Contents
1515
- [Installation](#installation)
1616
- [Wrapper script](#wrapper-script)
1717
- [Completion rules](#completion-rules)
18-
- [Setup](#setup)
19-
- [Configure your default editor](#configure-your-default-editor)
20-
- [Clone a bare repository](#clone-a-bare-repository)
21-
- [Setup fetch rules to the remote](#setup-fetch-rules-to-the-remote)
18+
- [Setup default editor](#setup-default-editor)
2219
- [Usage](#usage)
20+
- [Clone and setup a bare repository](#clone-and-setup-a-bare-repository)
21+
- [Setup fetch rules from the remote](#setup-fetch-rules-from-the-remote)
2322
- [Open an existing branch or worktree](#open-an-existing-branch-or-worktree)
2423
- [Comparison with vanilla `git-worktree`](#comparison-with-vanilla-git-worktree)
2524
- [Create a new branch or worktree](#create-a-new-branch-or-worktree)
@@ -83,9 +82,7 @@ _complete_alias_overrides() {
8382
```
8483

8584

86-
# Setup
87-
88-
## Configure your default editor
85+
## Setup default editor
8986

9087
Set the environment variable `EDITOR` in your `~/.bashrc`,
9188
`git-worktree-wrapper` will try to open worktree directories using this editor.
@@ -101,28 +98,24 @@ Or set `DISABLE_GIT_WORKTREE_EDITOR=1` to disable usage of editors.
10198
export DISABLE_GIT_WORKTREE_EDITOR=1
10299
```
103100

104-
## Clone a bare repository
101+
# Usage
102+
103+
## Clone and setup a bare repository
105104

106-
Try it with this repo!
105+
Try with this repo!
107106

108107
```sh
109108
git clone --bare https://github.com/lu0/git-worktree-wrapper
110109
cd git-worktree-wrapper.git
111110
```
112111

113-
## Setup fetch rules to the remote
112+
### Setup fetch rules from the remote
114113

115114
```sh
116115
git config --local remote.origin.fetch +refs/heads/*:refs/remotes/origin/*
117116
git fetch
118117
```
119118

120-
121-
# Usage
122-
123-
After cloning a bare repository, you can use the following common `git checkout` and
124-
`git branch` commands.
125-
126119
## Open an existing branch or worktree
127120

128121
Switch to branch `master` and *cd* into its worktree, **even if you are *cd'd* into

0 commit comments

Comments
 (0)