From c0420a7022e9fec2e875196b363e71d05cbb1696 Mon Sep 17 00:00:00 2001 From: Joe Groocock Date: Sat, 21 Apr 2018 01:10:10 +0100 Subject: [PATCH] Add a more relevant README Addresses #1 --- README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2c6dac9..c3a4584 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,10 @@ -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 +# frebib/dotfiles ## Usage -To quickly get started, clone this repo and run the setup scripts. +To get started, clone this repo and link the relevant files/directories - git clone https://github.com/frebib/dotfiles.git ~/.config/dotfiles - cd ~/.config/dotfiles - -You can put the `dotfiles` directory anywhere, just be sure to update the `$DOTFILES` envvar in `.profile` - -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 - -To install all of my packages & programs, check out my other repo and the [`userinstall`](https://github.com/frebib/arch-install/blob/master/userinstall) script +```shell +git clone https://github.com/frebib/dotfiles.git ~/.config/dotfiles +ln -sfv .config/dotfiles/.config/* .config/ +ln -sfv .config/dotfiles/.profile .zprofile +```