From 4f3faee47c32e534e585cfb790787e5cfccd2398 Mon Sep 17 00:00:00 2001 From: Joseph Groocock Date: Thu, 31 Mar 2016 18:51:28 +0100 Subject: [PATCH] Added minimal readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..25484c1 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +These are the configs I use on my Arch Linux installation at home. They can be use and changed as much or as little as you please + +## Usage +To quickly get started, clone this repo and run the setup scripts. + + git clone https://github.com/frebib/dotfiles.git ~/.config/dotfiles + cd ~/.config/dotfiles + +To install all of my packages & programs, run the setup script: + + scripts/setup.sh + +To link all the configuration files, run the init-dotfiles script: +**Be warned that this will destroy your current configs without warning** + + scripts/init-dotfiles.sh