Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
git
 
 
 
 
 
 
 
 
 
 
 
 
 
 
zsh
 
 
 
 
 
 
 
 
 
 

My i-dotfiles

i-dotfiles is an opinionated dotfiles organization scheme based on stow.

Includes co-managed emacs emacs.d and zsh zprezto repositories.

Install

Starting points:

General Idea

Refer to specific "Starting point" README.md files above for specific details.

Assumes git and GNU stow are available/installed (usually via a package manager). In general, it will go as follows:

  1. Clone this repository:

    $ git clone --recurse-submodules \
      https://github.com/idcrook/i-dotfiles.git \
      ~/.dotfiles
    $ cd ~/.dotfiles
  2. Install GNU stow config itself

    $ stow -t ~ stow

    IMPORTANT: Confirm that the hard-coded home directory path in ~/.stowrc matches your system

  3. Use stow to install desired package(s) via stow <directory> 1

    • Additional installation instructions are present in respective package README.md files.

Rules

Sub-Directory Naming

  • lowercase - for packages to install in $HOME (the default)

  • TitleCase - for packages which need root permissions, e.g. top-level of filesysyem at / @Daemon-macos

  • leading @ - for environment packages and subpackages, e.g. @macos

  • leading _ - for non-stow-able packages, e.g. _pip which describes python package installation

Having a convention for sub-package naming enables a .stow-global-ignore file such that sub-packages are not symlinked when stowing parent package.

Ignore files

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.

Using .gitignore in packages because of this behaviour, can be useful for avoiding having this git repository cluttered with unknown files, when language package managers or App configs introduce files in certain directories.

Secrets files

Secrets files, i.e., files that should not be committed to git repository, must have *.secrets* or */secrets/* in their filepath to be ignored by the root .gitignore file.

Each secrets file should be accompanied by an *.example* file that is, itself, instead commited to repository, to illustrate the contents.

Keep your secrets files as short as possible to limit their influence as it complicates deployments (as they are not available in the git repository).

See example.

Multi-platforms paths

Where to save a file that is installed at different locations depending on the OS?

The trick is to have one sub-package per OS, just to create each specific directory structure properly.

Then create the part of the filepath that is common to the two OS-es in <package>/_common, put the files in it, symlink from the subpackages to that location.

Feel confused ? Check example

Background

I used to manage my macOS/Linux/WSL dotfiles in an "homedir.git" repository that was directly overlayed. This left things to be desired, and syncing multiple platforms sometimes presented unresolvable conflicts. Now, I use GNU Stow and this repository instead.

i-dotfiles is an opinionated dotfiles organization scheme based on stow. Its priorities are ease-of-maintenance and deployment on both Linux and macOS. It was created originally as an implementation of F-dotfiles, borrowing its philosophy as follows:

  • stow powered: symlink dotfiles and thus keep them always up-to-date in git repository
  • topical organization: organize dotfiles by application facilitating reuse across different machines
  • naming schemas: the repository architecture is easy to browse while staying compatible with stow symlinking mechanism
  • KISS: there is deliberately no build script involved at all, the repository consist of dotfiles all installable using same modus operandi (stow <directory>)
  • documentation: each "package" directory has a README.md which presents its purpose. Install notes and requirements can be included. A separate TODO.md may be enlisted to track things still to be implemented.

Inspired heavily by:


1 it's because we installed stow package at step 2 that the flag -t ~ can be omitted here, see .stowrc

About

GNU stow managed dotfiles for macOS and Linux with BASH and zsh (zprezto) and .emacs.d and more

Topics

Resources

Releases

No releases published

Packages

No packages published

Languages