From d101aa9ba81060ac062efcbc37a52eb333d48efd Mon Sep 17 00:00:00 2001 From: Gwen Lofman Date: Mon, 10 Jul 2017 19:41:49 -0400 Subject: [PATCH] Add README.md Describes setup and installation of my dotfiles with a (very) brief description. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..702ac05 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# dotfiles + +Yet another dotfiles repository: configuration and scripts for linux machines (basically debian derivatives). + +Includes my functions, environment variables, path, custom prompt with git prompt, and more goodies. + +# Setup instructions + +When running on a new system, to install development files use + +```bash +git clone https://github.com/Lionex/dotfiles ~/.dotfiles && cd ~/.dotfiles && . install.sh +``` + +To simply symlink the dotfiles, use + +```bash +git clone https://github.com/Lionex/dotfiles ~/.dotfiles && cd ~/.dotfiles && . setup.sh +```