Expand README
This commit is contained in:
23
README.md
23
README.md
@@ -1,6 +1,6 @@
|
|||||||
# Sigil
|
# Sigil
|
||||||
|
|
||||||
Minimal dotfile symlink manager with per-package Lua config.
|
Sigil is a minimal symlink-based dotfile manager with per-package Lua config.
|
||||||
|
|
||||||
## Install (dev)
|
## Install (dev)
|
||||||
|
|
||||||
@@ -10,17 +10,21 @@ go run . <command>
|
|||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
- `sigil apply` - apply symlinks from `~/.dotfiles`
|
- `sigil apply` — apply symlinks from `~/.dotfiles`
|
||||||
- `sigil add <path>` - add an existing file or folder (merges into existing package for single files)
|
- `sigil apply --prune` — prune stale links without prompting
|
||||||
|
- `sigil add <path>` — add a file/dir to the repo and symlink it
|
||||||
|
- `sigil status` — show stale links
|
||||||
|
- `sigil unlink <spec>` — restore file(s) and remove from repo
|
||||||
|
- `sigil remove <spec>` — same as unlink, plus remove package/subpath
|
||||||
|
|
||||||
## Repo layout
|
## Repo layout
|
||||||
|
|
||||||
```
|
```
|
||||||
~/.dotfiles/
|
~/.dotfiles/
|
||||||
nvim/
|
<package>/
|
||||||
config.lua
|
config.lua
|
||||||
files/
|
files/
|
||||||
init.lua
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
## `config.lua`
|
## `config.lua`
|
||||||
@@ -35,7 +39,16 @@ return {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Spec formats
|
||||||
|
|
||||||
|
`unlink/remove` accept:
|
||||||
|
- `package`
|
||||||
|
- `package:relative/path`
|
||||||
|
- repo path: `~/.dotfiles/<pkg>/files/...`
|
||||||
|
- target path: e.g. `~/.config/<app>/...`
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- Uses `SIGIL_REPO` env var to override the repo path.
|
- Uses `SIGIL_REPO` env var to override the repo path.
|
||||||
- Conflicts are detected (existing non-symlink files will stop apply).
|
- Conflicts are detected (existing non-symlink files will stop apply).
|
||||||
|
- Prefer `sigil add` over manual edits in `files/`.
|
||||||
|
|||||||
Reference in New Issue
Block a user