From eb7ad8a0ab3894c978df59a0e47b96b4e534800b Mon Sep 17 00:00:00 2001 From: james Date: Thu, 21 May 2020 18:48:09 +0000 Subject: [PATCH] Update 'zsh/README.md' Fixed formatting formatting caused by automatic line breaks from doom. Added install section. --- zsh/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/zsh/README.md b/zsh/README.md index c592a85..f5231fc 100644 --- a/zsh/README.md +++ b/zsh/README.md @@ -1,6 +1,16 @@ # ZSH +## Install + +Install for this follows the norm for the rest of the dotfiles. `cd` to this directory and run + +```make install``` + +or if you are on a machine where BSD Make is installed by default: + +```gmake install``` + ## File Structure. The file structure looks something like this: Nodes with a trailing "δ" are directories. @@ -23,16 +33,12 @@ zsh └── zshrc ``` -* `environment` :: This is the contains environment base logic and contains. At - each step of the zsh loading process the `env_loader` function will load the - corresponding file. +* `environment` :: This is the contains environment base logic and contains. At each step of the zsh loading process the `env_loader` function will load the corresponding file. * `host` :: Loaded Automatically. Conditionally loads by based on `$HOST` value. * `os` :: Loaded Automatically. Conditionally loads by based on `$OSTYPE` value. * `makefile` :: Install/Update/Remove makefile. * `modules` :: Local modules loaded by [zplug](https://github.com/zplug/zplug). * `transient` :: Files that are required for zsh (eg history), that are not to be versioned. -* `zlogin`/`zlogout`/`zprofile`/etc :: The default shell resource files. See - [here](https://shreevatsa.wordpress.com/2008/03/30/zshbash-startup-files-loading-order-bashrc-zshrc-etc/) - for more infomation on load order. +* `zlogin`/`zlogout`/`zprofile`/etc :: The default shell resource files. See [here](https://shreevatsa.wordpress.com/2008/03/30/zshbash-startup-files-loading-order-bashrc-zshrc-etc/) for more infomation on load order. * `zplug` :: How to load modules.