diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..17c5682 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Dotfiles + +## Folders in Home Folder + +- `~/personal/`: Holds Personal Folders that are created by `run` script + - `bin/`: Holds all executables; Things are copied here only, no changes + - `plan9/`: Plan9Port + - `neovim/`: Neovim source; binaries go to `bin/` + - `dotfiles/`: Dotfiles are edited here & copied to correct location + - `notes/`: Personal Notes repository + +## Install + +First execute `./run` which will handle things like installing Neovim & P9P. +Next to copy the files to the proper directory, run `./dev-env`, which will +copy config files to `~/.config/` folder and executables to `~/personal/bin/`. + |