1 files changed, 59 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..bf6dafe
--- /dev/null
+++ b/README.org
@@ -0,0 +1,59 @@
+* README
+
+I have setup these dotfiles to make use of GNU Stow to be installed on any of my machines.
+
+The .stowrc expects this repository to exist in =~/configs/dotfiles/= if it is not - please ammend as necessary.
+
+** Installing your dotfiles
+
+After you clone the repository simply run:
+
+ #+begin_src shell
+   $ stow .
+ #+end_src
+
+This will generate an output of all of the config files as needed!
+
+*** Removing installations
+
+If you need to revert anything just use
+
+#+begin_src shell
+  $ stow -D .
+#+end_src
+
+
+*** .file vs dot-file
+
+Ideally, I would use dot-file instead, since it makes visibility much easier depending on the editing program. HOWEVER, .config is busted with the =--dotfiles= configuration in =.stowrc= so for now I am using the standard 1:1 syntax.
+
+We can track that bug on the [[https://github.com/aspiers/stow/issues/33][aspiers/stow github]] page.
+
+** Local PC Changes
+
+Ideally, ALL of these dotfiles are suitable per PC. But there are always some PC local changes that are needed.
+
+Any configuration that REQUIRES PC Local configurations should be extended where possible to contain them - i.e:
+
+#+begin_src shell
+  # .bash_profile
+  if [ -f ~/.pc_local_bash_profile ]; then
+      source ~/.pc_local_bash_profile
+  fi
+#+end_src
+
+I don't have a good solution for how to version control these local changes - but ideally anything specific could be moved either into an environment variable, or should be SPECIFIC things that don't really need preservation.
+
+** Ignore Files
+
+To ignore files simply amend the =.stowrc= file with an =--ignore=<regex>= .
+
+** LICENSE
+
+I threw the 0BSD on here since you could PROBABLY classify some of this as code, and frankly, I don't give a crap about anything that's in here. Use it! This is all cool stuff, and I don't need any attribution, most of this is evolved from interenet examples anyway!
+
+View [[https://opensource.org/license/0bsd/][Zero Clause BSD License]] site.
+
+
+
+