From d53e75c8a99a03bf74b548a067dcf8bec5f11fe8 Mon Sep 17 00:00:00 2001 From: Tucker Evans Date: Sun, 6 Jun 2021 20:01:24 -0400 Subject: Update readme --- README.adoc | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.adoc (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..8bc5375 --- /dev/null +++ b/README.adoc @@ -0,0 +1,36 @@ +Tucker's Dotfiles +================= + +These dotfiles are here mostly to move them between my computers and +as a backup, but feel free to use them yourself. + +Vim Plugins +----------- +I keep my vim plugins as submodules in this repo, I use +`github.com/tuckerevans/plugVim `_ +to manage them. + + +Installation +------------ + +dotfiles +~~~~~~~~ + +NOTE: I recommend backing up any existing dotfiles you have before + installing these, you can do this with the following command + `cp .dotfile_to_backup .dotfile_to_backup.bak` + +Running `make process` should run the necessary files through m4 and compile my +input program for lemonbar. + +I recomend using https://www.gnu.org/software/stow/[`stow`] to +manage these files. `make stow` should stow all of these dotfiles. +This can be also be done with the following command. + +`stow [program]` for each program's dotfiles you want to use + +==== +Example: `stow vim` or `stow mutt` +==== + -- cgit v1.1