diff options
author | Josh Rahm <joshuarahm@gmail.com> | 2021-11-21 17:39:29 -0700 |
---|---|---|
committer | Josh Rahm <joshuarahm@gmail.com> | 2021-11-21 17:39:29 -0700 |
commit | 3cb9768298d4673792344762a7a19a08f61333bd (patch) | |
tree | 866cd8e98092542a9f5735a4c5a94b48afd66425 | |
parent | 0872f22a68e2faea5f7948c1b9a11f2a2303efaf (diff) | |
download | zshrcd-3cb9768298d4673792344762a7a19a08f61333bd.tar.gz zshrcd-3cb9768298d4673792344762a7a19a08f61333bd.tar.bz2 zshrcd-3cb9768298d4673792344762a7a19a08f61333bd.zip |
Added more documentation to zshrcd.
-rw-r--r-- | README.md | 20 | ||||
-rw-r--r-- | zshrc | 3 |
2 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4ca4b51 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Rahm's Zsh Files. + +This is my hand-rolled ZSH configuration system. + +It's pretty simple how it works. Each of the `*.zsh` files in this directory are +sourced in alphabetical order by the `zshrc` file. + +Local configurations are stored in the `local/ directory`. The same rules apply; +however, these files are covered by the `.gitignore` and thus are designed to be +local-only configuration that is not committed to git. + +Prompts are selected based no the hostname and are stored in the `prompts/` +folder. Specifically, `prompts/$(hostname).zsh` is sourced. + +## Installation + +```sh +git clone git://git.josher.dev/zshrcd.git ~/.zshrc.d && \ + ln -s ~/.zshrc.d/zshrc ~/.zshrc +``` @@ -1,3 +1,6 @@ +# Loads the other files in order. This file should not be touched. It is used +# simply as a way to load the other files in the .zshrc.d folder. + for f in $HOME/.zshrc.d/*.zsh ; do source "$f" done || true |