A framework of dotfiles for the usual terminal apps and shells designed to be cross platform and degrade for older machines
- Backup, restore, and sync the prefs and settings for your toolbox. Your dotfiles might be the most important files on your machine.
- Learn from the community. Discover new tools for your toolbox and new tricks for the ones you already use.
- Share what you've learned with the rest of us.
Sign up for an account on github and fork the project
git clone --recursive [email protected]:*username*/dotphiles.git ~/.dotfiles
Edit dotsyncrc and select which dotfiles to use
Then symlink then into place with
./.dotfiles/dotsync/bin/dotsync -L
An existing ~/.dotfiles will be backed up into ~/.backup/dotfiles.old on init
Any existing files will be backed up into ~/.backup/dotfiles/
dotphiles is set to use the solarized theme, so you need to install the colors scheme and fonts for your terminal,
see the files in ~/.dotfiles/bootstrap
Add the dotfiles and machines to sync into dotsyncrc
Add your own settings to zshrc, zshenv, zlogin, zlogout and zprofile
Add your own settings to vimrc and start vim to auto install plugins
Add your name, email and gpg keyid to gitconfig
Add your known hosts to ssh/config and your public key to ssh/authorized_keys
To keep your fork upto date with additions to the dotphiles repo, do the following
cd ~/.dotfiles
git remote add upstream https://github.com/dotphiles/dotphiles
git fetch upstream
git merge upstream/master
This project would not exist without all of its users and contributors.
If you have ideas on how to make the configuration easier to maintain or improve its performance, do not hesitate to fork and send pull requests.
- Check that the issue has not already been reported.
- Check that the issue has not already been fixed in the latest code.
- Open an issue with a clear title and description in grammatically correct, complete sentences.
- Read how to properly contribute to open source projects on GitHub.
- Use a topic branch to easily amend a pull request later, if necessary.
- Write good commit messages.
- Squash commits on the topic branch before opening a pull request.
- Use the same coding style and spacing.
- Open a pull request that relates to but one subject with a clear title and description in gramatically correct, complete sentences.
Copyright (c) 2012 Ben O'Hara [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.