summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2024-12-05 13:49:22 -0500
committerJacob McDonnell <jacob@jacobmcdonnell.com>2024-12-05 13:49:22 -0500
commitf8d09c5cfd6d1d9595b64547dc9d29c63e40c5f2 (patch)
tree0dd9cfa47cfa0bd4d57d7789439cc86afbbdfa85 /README.md
parent29b1c791f6e319cdab828cee5f491ca1c38e41d1 (diff)
Moved .local/bin to scripts
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
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/`.
+