Danne's dotfiles
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
doc
src
.gitignore
LICENSE.txt
README.md
install
uninstall

README.md

dot dotfiles

Danne's dotfiles. Make yourself at home.

Installation

Prerequisites

  • Git for version control
  • Curl for HTTP network communication
  • Ruby for systems automation
  • RVM for Ruby version builds and management

Before setting this up, you'll really want to have the above tools installed. If using Ubuntu Linux, the following command should get these lined up for you:

$ sudo apt-get install git curl ruby

Next, RVM is installed with:

$ \curl -L https://get.rvm.io | bash -s stable --ruby

Once you have RVM available, clone this repository into your new home folder

$ git clone https://linenoise@github.com/linenoise/.dotfiles.git

Next, link the freshly cloned dotlings into their new homes

$ ./.dotfiles/install

This will go through and backup any existing dotfiles into ~/.dotfiles/backups.

Maintenance

Before making any changes to the dotfile collection on github, you'll need to setup your SSH keys to be able to read from the repository. Once this is in place, change from the read-only HTTP url to the read/write GIT url with the following:

$ git remote set-url origin git://github.com/linenoise/.dotfiles.git

Once this is in place, you can make any changes you like to the dotfile repository:

To add a dotfile to this collection, run:

$ dotadd .screenrc

To remove a dotfile from this collection, run:

$ dotrm .screenrc

To push a change on a dotfile to the github repo, run:

$ dotpush .screenrc "here is a description of what I changed"

To sync dotfiles with the github repo, run:

$ dotpull

To see which files have local changes, run:

$ dotstat

To see what's changed in a local tile, run:

$ dotdiff .screenrc

Documentation

Utility documentation is available in the doc/ directory, autogenerated from source comments. To regenerate this documentation, run:

$ rdoc install uninstall bin/* -N

Uninstallation

Do the above in reverse:

$ ./.dotfiles/uninstall

This will tell you if it had trouble restoring any backed up files. You may need to handle some of those manualy.

$ rm -rf ~/.dotfiles

Have fun!

License

.dotfiles is available under the GNU GPL, version 3. Full details are in LICENSE.txt in this distribution.