diff --git a/README.org b/README.org index d0602d1..b667147 100644 --- a/README.org +++ b/README.org @@ -1,16 +1,26 @@ * Dotfiles -** Compilation of my essential configs, managed with GNU stow +Compilation of my personal dotfiles, you will need to tweak them for your system. +I try to comment as many files as possible. -Every configuration file is categorized, inside a parent folder. +** Deployment -If you want to deploy them without using GNU stow, copy the -configuration file with the corresponding folder hierarchy, in your home -folder. -For example: +The deployment is done via GNU stow, which can be done in a few steps: + +1. Clone the repository + +#+BEGIN_SRC sh +git clone https://git.coolneng.duckdns.org/coolneng/dotfiles ~/.dotfiles +#+END_SRC + +2. Change the working directory #+BEGIN_SRC sh - cd vim - cp .vimrc ~/.vimrc - cp -R .vim ~/.vim +cd ~/.dotfiles +#+END_SRC + +3. Execute stow on all the folders + +#+BEGIN_SRC sh +stow * #+END_SRC