Files
dotfiles/AGENTS.md
Sebastian Moser 72a707299f ...
2026-11-02 21:53:31 +01:00

26 lines
1.8 KiB
Markdown

# c2vi's dotfiles monorepo
this is c2vi's dotfiles repo and also monorepo where projects of active development are kept as git submodules.
for any coding work read these two guides:
@./mize/docs/general-agent-guide.md
@./mize/USING-MIZE-FOR-AGENTS.md
## other notes
to modify an existing application: wrappers, config files
to create new functionality: mize parts
- if not specified otherwise create the part under `./parts/c2vi.vibed.<name-of-part>` for anything related to c2vi (the owner of these dotfiles) or `./mize/parts/vibed.<name-of-part>` for anything generally usefull to the mize project.
## the dotfile system
- most importantly my dotfile system does not install anything to any system locations. there is one symlink of the bashrc to add extra paths. all other programms are wrappers inside the dotfiles repo pointing to config files also in this repository via cmdline flags or env vars. (any new config should apply to this convention)
folders:
- ./shared ... any config files which are shared between hosts
- ./hosts/<hostname> ... host specific config files (or partial config files which are included in the shared ones)
- ./hosts/<hostname>/bin ... added to the path of a specific host
- ./bin ... added to the path on every host.
the wrappers need to include the shared config file as well as the host-specific one if it exists. In case the programm does not allow specifying two config files the wrapper should cat both of them into one file in `$TMPDIR/combined-config-of-<prg-name>` everytime the programm is run. (a good example of a wrapper is `./bin/mize`)
longer config files are split up into smaller pieces seperated by a comment like `/////////////// does this and that /////////////` grouping config sections into functional units of sorts. new functionality would get it's own section.