aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTucker Evans <tuckerevans24@gmail.com>2018-02-01 01:57:46 -0500
committerTucker Evans <tuckerevans24@gmail.com>2018-02-01 01:57:46 -0500
commit198a40c17d6ae1bc880e181d10eff68232665cfe (patch)
tree7e304a688d0caf29715921d4d0584b5feecbf000
parent851f86bec16d12575507b51667f4e08946399d0e (diff)
Added README
-rw-r--r--README.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..e373989
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,24 @@
+Tucker's Dotfiles
+=================
+
+These dotfiles are here mostly move them between my computers and
+as a backup, but feel free to use them yourself.
+
+Installation
+------------
+
+.. note ::
+ I recommend backing up any existing dotfiles you have before
+ installing these, you can do this with the following command
+ :code:`cp .dotfile_to_backup .dotfile_to_backup.bak`
+
+
+I recomend using `stow <https://www.gnu.org/software/stow/>`_ to
+manage these files. This can be done with the following commands.
+
+1. :code:`cd ~`
+2. :code:`git clone https://github/tuckerevans/dotfiles`
+3. :code:`cd dotfiles`
+4. Run :code:`stow [program]` for each program's dotfiles you want to use
+
+ *Example:* :code:`stow vim` or :code:`stow mutt`