james/dotfiles
1
0
Fork 0
Code Issues 7 Pull Requests Releases Activity

Update 'zsh/README.md'

Browse Source 
Fixed formatting formatting caused by automatic line breaks from doom. Added install section.
This commit is contained in:
james 2020-05-21 18:48:09 +00:00
parent 2667d7e16f
commit eb7ad8a0ab
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
zsh/README.md
View File

@ -1,6 +1,16 @@
# ZSH # 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. ## File Structure.
The file structure looks something like this: Nodes with a trailing "δ" are directories. The file structure looks something like this: Nodes with a trailing "δ" are directories.
@ -23,16 +33,12 @@ zsh
└── zshrc └── zshrc
``` ```
* `environment` :: This is the contains environment base logic and contains. At * `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.
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. * `host` :: Loaded Automatically. Conditionally loads by based on `$HOST` value.
* `os` :: Loaded Automatically. Conditionally loads by based on `$OSTYPE` value. * `os` :: Loaded Automatically. Conditionally loads by based on `$OSTYPE` value.
* `makefile` :: Install/Update/Remove makefile. * `makefile` :: Install/Update/Remove makefile.
* `modules` :: Local modules loaded by [zplug](https://github.com/zplug/zplug). * `modules` :: Local modules loaded by [zplug](https://github.com/zplug/zplug).
* `transient` :: Files that are required for zsh (eg history), that are not to * `transient` :: Files that are required for zsh (eg history), that are not to
be versioned. be versioned.
* `zlogin`/`zlogout`/`zprofile`/etc :: The default shell resource files. See * `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.
[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. * `zplug` :: How to load modules.