Configuration files are linked automatically using ln. Files within the home directory in each topic will be symbolically linked from $HOME in the same file structure. For example, topic/home/foo/bar.zsh will be symbolically linked at $HOME/foo/bar.zsh. If there are existing files that conflict with the linked files, they will be renamed with a .old suffix, e.g., $HOME/foo/bar.zsh.old.
Any script named install.zsh within the base directory of each topic will run during installation. Use these scripts to install applications, set environment variables, write initialization scripts, etc.
Within each topic directory, any file named init.zsh (e.g., topic/init.zsh) will be sourced first. Then, all files prefixed with a number (e.g., topic/01_config.zsh) will be sourced in alphabetical order within $HOME/.zshrc. Use these files to implement custom configurations that need to be loaded with each shell instance.
When zsh/install.zsh is executed, the list of plugins (defined within zsh/plugin_repos.zsh as an array of GitHub repositories with format <author>/<name>) will be cloned into the zsh/plugins directory. All *.zsh files are then compiled, and zsh/plugins/init.zsh will be generated sourcing each plugin. All functions within zsh/functions will also be compiled, and zsh/init.zsh will be generated which will add each directory within zsh/functions to fpath and autoload each function.
In $HOME/.zshrc (which is symbolically linked to zsh/.zshrc.linked), every init.zsh within any topic directory is sourced, then every *.zsh file that is prefixed with a number within any topic directory will be sourced in alphabetical order. Within zsh/03_plugins.zsh, the function dotfiles load_plugins is called which sources zsh/plugins/init.zsh. This way, you can control what is loaded before and after plugins are loaded.
Running dotfiles update will pull all plugin repositories as well as the main dotfiles repository. It may be necessary to recompile by running dotfiles recompile which will recompile any files that have changed since they were last compiled. After updating or compiling, you can reload shell by running dotfiles reload to see the effect of any changes.
Running dotfiles benchmark will download the latest version of zsh-bench to the plugins folder and run it.
The install script for this topic will only run if it is being run within a macOS environment, so you could add all kinds of macOS specific system configuration here without affecting Linux environments which run the same installer.
It will check whether or not Homebrew is installed, and if not, run the installer in non-interactive mode. It will also statically define the required paths in init.zsh so that the brew shellenv script isn't called on every shell load as the installer recommends. It then looks through all topics for a folder brew containing a Brewfile and runs brew bundle install --file=Brewfile.
It will use Homebrew to install the latest version of Python and set aliases for python and pip within init.zsh to point to the brew installed python3 and python3 -m pip. It then updates pip and looks through all topics for a folder pip containing a requirements.txt and runs pip install -r requirements.txt.
It will use Homebrew to install the latest version of zsh and set it to your default shell. On Apple silicon, this will make your zsh use the latest arm64 native build rather than the slightly dated x64 build that ships with macOS by default.
curl -fsSL https://raw.githubusercontent.com/ndunnett/dotfiles/master/install.sh | sh
or
wget -qO - https://raw.githubusercontent.com/ndunnett/dotfiles/master/install.sh | sh
On GitHub, navigate to Settings > Codespaces, tick Automatically install dotfiles and populate the repository field.
In VSCode, navigate to Settings > User > Extensions > Dev Containers, and populate Dotfiles: Repository.