Skip to content

Commit

Permalink
Document aspirational features
Browse files Browse the repository at this point in the history
  • Loading branch information
9999years committed Sep 24, 2024
1 parent cb5b9e0 commit 9afc843
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,36 @@
A [`git-worktree(1)`][git-worktree] manager.

[git-worktree]: https://git-scm.com/docs/git-worktree/en

## Features

(This is a TODO list.)

A normal Git checkout looks like this:

```
my-repo/
+ .git/
+ README.md
+ ...
```

A worktree checkout looks like this:

```
my-repo/
+ main/
+ .git/
+ README.md
+ ...
+ my-feature-branch/
+ ...
```

- [ ] Convert a Git checkout to a worktree checkout.
- [ ] Clone a repo into a worktree, using the main branch name from the remote.
- [ ] Add a worktree. The worktree should be associated with the main upstream
branch, unless another is given (rather than the default of the
currently-checked-out branch).
- [ ] Copy over files, like `.envrc` or `.nvim.lua`.
- [ ] Remove a worktree. (This will just be an alias for `git worktree remove`.)

0 comments on commit 9afc843

Please sign in to comment.