rik/dotfiles
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixing README

Browse Source
This commit is contained in:
Nick Nisi
2012-05-04 15:29:48 -05:00
parent 7431ca2fcc
commit 87cdc880d1
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -15,7 +15,8 @@ These are my dotfiles, which contain my custom system configuration preferences.
The organization of this project is similar to [Zach Holman's ](http://github.com/holman/dotfiles) setup. The organization of this project is similar to [Zach Holman's ](http://github.com/holman/dotfiles) setup.
### Clone #### Clone
First, clone the repository to your home directory and name it ".dotfiles" First, clone the repository to your home directory and name it ".dotfiles"
git clone git@github.com:nicknisi/dotfiles.git ~/.dotfiles git clone git@github.com:nicknisi/dotfiles.git ~/.dotfiles
@@ -23,13 +24,14 @@ First, clone the repository to your home directory and name it ".dotfiles"
Then cd into that directory Then cd into that directory
cd ~/.dotfiles cd ~/.dotfiles
#### Backup
#### Backup
A backup task is included. This will find all the files that will be replaced and make a backup of them. For example, if you currently have a ".zshrc" file, it will be moved to ".zshrc.backup" A backup task is included. This will find all the files that will be replaced and make a backup of them. For example, if you currently have a ".zshrc" file, it will be moved to ".zshrc.backup"
rake backup rake backup
### Install #### Install
Symlink the necessary files. The task will perform a search for all files in the *.dotfiles* directory that have the ".symlink" suffix and create a symbolic link in the home directory that drops the suffix and prefixes with a '.' Symlink the necessary files. The task will perform a search for all files in the *.dotfiles* directory that have the ".symlink" suffix and create a symbolic link in the home directory that drops the suffix and prefixes with a '.'
@@ -39,8 +41,12 @@ Symlink the necessary files. The task will perform a search for all files in th
If you would like to bring back your previous configuration, run the uninstalll task. This will remove the created symlinks. If you would like to bring back your previous configuration, run the uninstalll task. This will remove the created symlinks.
#### Uninstall
rake uninstall rake uninstall
#### Restore
Then, if you would like to restore your previous configuration, run the restore task. Then, if you would like to restore your previous configuration, run the restore task.
rake restore rake restore