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 ++++++++++++++++++++++++++++++++++++ README.rst | 54 ------------------------------------------------------ 2 files changed, 36 insertions(+), 54 deletions(-) create mode 100644 README.adoc delete mode 100644 README.rst 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` +==== + diff --git a/README.rst b/README.rst deleted file mode 100644 index 3d4962f..0000000 --- a/README.rst +++ /dev/null @@ -1,54 +0,0 @@ -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. - -Branches --------- - -I keep the master branch as templates for new systems. Each of my -computers then have their own branch, this is to account for different -font size and other necessary changes. Any changes that need to be -made i.e. font change, are changed to "!INPUT" in files for easy -search/repace. Example, Xresourses:: - - XTerm*faceName: !FONT - UXTerm*faceName: !FONT - - XTerm*faceSize: !FONT_SIZE - UXTerm*faceSize: !FONT_SIZE - - XTerm*allowBoldFont: false - UXTerm*allowBoldFont: false - - -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 - :code:`cp .dotfile_to_backup .dotfile_to_backup.bak` - - -I recomend using `stow `_ to -manage these files. This can be done with the following commands. - -1. :code:`cd ~` -2. :code:`git clone https://github.com/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` - -- cgit v1.1