diff --git a/README.org b/README.org index 06f3523..33ed57e 100644 --- a/README.org +++ b/README.org @@ -10,14 +10,14 @@ - Set everything up with one command - Updating configurations shall require nothing more than =git pull= - This is a reference repository which contains a =setup= bash script and some example dotfiles for two machines called =host1= and =host2=. + This is a reference repository which contains a bash script and some example dotfiles for two machines called =host1= and =host2=. *Warning*: If you want to try this make a backup of your dotfiles! - The =setup= script doesn't overwrite existing files but you never know. + The script doesn't overwrite existing files but you never know. ** Concept - The concept is based on symlinks and two directories called =common= and =machines= and a =setup= bash script. + The concept is based on symlinks and two directories called =common= and =machines= and a bash script called =dotlink=. The =machines= directory contains subdirectories for all machines on which dotfiles are managed. They need to match the /hostname/ of the machine (in this repository =host1= and =host2=) and mimic the corresponding =$HOME= directories. @@ -47,12 +47,12 @@ │   ├── beets │   │   └── config.yaml │   └── mpv -> ../../../common/mpv/ - └── setup + └── dotlink #+end_example The *mpv* configuration is shared between hosts, =host1= has an *OfflineIMAP* configuration in his home directory and =host2= has a *beets* configuration in his =.config= directory. - When calling the =setup= script, all files from the directory which matches the current /hostname/ are linked to their destination in the =$HOME= directory. + When calling the =dotlink= script, all files from the directory which matches the current /hostname/ are linked to their destination in the =$HOME= directory. Calling the script is only neccessary when new files are added. If you updated a configuration somewhere else just call =git pull= and thats it. @@ -63,4 +63,4 @@ 1. Add the files to the =common= directory 2. Execute =ln -rs common/ machines//= for every machine on which the files should be present - 3. Call the =setup= script on every modified machine + 3. Execute the =dotlink= script on every modified machine diff --git a/setup b/dotlink similarity index 100% rename from setup rename to dotlink