F-dotfiles is an opiniated dotfiles organization scheme based on stow.
Highest priorities are ease of maintenance and deployment on both Linux and OS X.
stowpowered: symlink dotfiles and thus keep them always up-to-date in your repository
- topical organization: organize dotfiles by application facilitating reuse across different machines
- clever naming scheme: the repository architecture is easy to browse while staying compatible with
- KISS: there is deliberately none build script involved at all, the repository consist of dotfiles all installable using same modus operandi (
- documentation: each package has a README.md which present its purpose and a flat
treeview of its files. Install notes and requirements can also be listed.
- clone the repository :
git clone https://github.com/Kraymer/F-dotfiles.git ~/ ; cd ~/F-dotfiles
stow, inception style :
stow -t ~ stow
- install desired package via
When needed, special install instructions are present in package
Walter - That rules really tie the repo together, do they not?
The Dude - Fuckin A ! 2
- lowercase for packages to install in
- titlecase for packages to install as root in
@for environment packages and subpackages, eg
_for non packages, eg
_homebrewmeaning that these directories must not be stowed
Having a convention for subpackage naming enable us to write a
.stow-global-ignore file so that subpackages are not symlinked when stowing parent package.
Quoting stow documentation :
if Stow can create a single symlink that points to an entire subtree within the package tree, it will choose to do that rather than create a directory in the target tree and populate it with symlinks.
.gitignore can be present in packages because of this behaviour, in order to avoid having your repository cluttered with unknown files, see example.
Secret files, ie files that should not be commited/published, must have .sec or /sec/ in their filepath to be ignored by the root
Each secret file should be accompagnied by an .example file that is commited instead, to illustrate the use.
Keep your secret files as short as possible to limit their influence as it complicates deployments (as they cannot be just pulled from github).
Where to save a file that is installed at different locations depending on the OS ?
The trick is to have one package per OS, just to create each specific directories structure properly.
Then create the part of the filepath that is common to the two OS in
<package>/_common, put the files in it, symlink from the subpackages to that location.
Feel confused ? Check example