docs: call out default worktrees dir (#64)
This commit is contained in:
@@ -30,6 +30,15 @@ default_engine = "codex" # optional, per-project override
|
|||||||
worktree_base = "master" # optional, base for new branches
|
worktree_base = "master" # optional, base for new branches
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note on `worktrees_dir`:
|
||||||
|
|
||||||
|
- The default `.worktrees` lives inside the repo root. You'll see it as an
|
||||||
|
untracked directory (with nested git worktrees) unless you ignore it.
|
||||||
|
- Options:
|
||||||
|
- add `.worktrees/` to your repo `.gitignore`, or
|
||||||
|
- set `worktrees_dir` to a path outside the repo (e.g. `~/.takopi/worktrees/<alias>`).
|
||||||
|
- add it to `.git/info/exclude` if you prefer a local-only ignore.
|
||||||
|
|
||||||
Validation rules:
|
Validation rules:
|
||||||
|
|
||||||
- `projects` is optional.
|
- `projects` is optional.
|
||||||
|
|||||||
@@ -100,6 +100,10 @@ default_engine = "codex"
|
|||||||
worktree_base = "master"
|
worktree_base = "master"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
note: the default `worktrees_dir` lives inside the repo, so `.worktrees/` will
|
||||||
|
show up as untracked unless you ignore it (add to `.gitignore` or
|
||||||
|
`.git/info/exclude`), or set `worktrees_dir` to a path outside the repo.
|
||||||
|
|
||||||
## usage
|
## usage
|
||||||
|
|
||||||
start takopi in the repo you want to work on:
|
start takopi in the repo you want to work on:
|
||||||
|
|||||||
Reference in New Issue
Block a user