diff --git a/README.rst b/README.rst index c1f74fd..4a5d2df 100644 --- a/README.rst +++ b/README.rst @@ -9,14 +9,14 @@ Installation 1. ``git clone git://github.com:whatevsz/dotfiles ~/dotfiles`` 2. ``bash ~/dotfiles/scripts/setup.bash`` -``makesymlinks,bash`` will back up all configuration files that would otherwise +``makesymlinks.bash`` will back up all configuration files that would otherwise be overridden and then symlink the content of all folders specified in $symlink_folders into $HOME or the desired destination given in MAPPING, if present. If you want to use a different directory instead of ``~/dotfiles``, just alter the first -line and replace ``~/dotfiles`` with the desired destination, and change the line +line and replace ``~/dotfiles`` with the desired destination and change the line ``config_dir="$HOME/dotfiles/"`` in ``scripts/setup.bash`` accordingly. You can -also choose a different folder for the backup of old files (default being ``~/.dotfiles,bak`` +also choose a different folder for the backup of old files (default being ``~/.dotfiles.bak``) by altering ``backup_dir`` in ``scripts/setup.bash`` to your needs. Structure @@ -41,7 +41,7 @@ Example:: terminator::.config/ -This will place the contents of the folder ``dotfiles/terminator`` into ``~/.config/`` +This will symlink the contents of the folder ``dotfiles/terminator`` into ``~/.config/`` When you provide multiple lines for the same folder, the first one that matches will be used.