https://github.com/civilcode/dotfiles
A set of zsh, git and other dev tool configuration files.
https://github.com/civilcode/dotfiles
Last synced: 2 months ago
JSON representation
A set of zsh, git and other dev tool configuration files.
- Host: GitHub
- URL: https://github.com/civilcode/dotfiles
- Owner: civilcode
- License: other
- Created: 2016-11-18T20:27:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-15T13:18:25.000Z (over 2 years ago)
- Last Synced: 2025-03-21T17:54:33.049Z (over 1 year ago)
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
CivilCode dotfiles
===================
Prerequisites
-------------
The following dependencies have been installed using the [laptop](https://github.com/civilcode/laptop)
script and you SHOULD NOT have to install these manually.
Install [rcm](https://github.com/thoughtbot/rcm):
brew tap thoughtbot/formulae
brew install rcm
Install
-------
Clone onto your laptop:
mkdir -p ~/Development && cd ~/Development
git clone https://github.com/civilcode/dotfiles.git
Install the dotfiles:
env RCRC=$HOME/Development/dotfiles/rcrc rcup
After the initial installation, you can run `rcup` without the one-time variable
`RCRC` being set (`rcup` will symlink the repo's `rcrc` to `~/.rcrc` for future
runs of `rcup`). [See
example](https://github.com/thoughtbot/dotfiles/blob/master/rcrc).
This command will create symlinks for config files in your home directory.
Setting the `RCRC` environment variable tells `rcup` to use standard
configuration options:
* Exclude the `README.md` and `LICENSE` files, which are part of
the `dotfiles` repository but do not need to be symlinked in.
* Give precedence to personal overrides which by default are placed in
`~/Development/dotfiles.local`
You can safely run `rcup` multiple times to update:
rcup
You should run `rcup` after pulling a new version of the repository to symlink
any new files in the repository.
Make your own customizations
----------------------------
Create a directory for your personal customizations:
mkdir ~/Development/dotfiles.local
Put your customizations in `~/dotfiles.local` appended with `.local`:
* `~/Development/dotfiles.local/aliases.local`
* `~/Development/dotfiles.local/git_template.local/*`
* `~/Development/dotfiles.local/gitconfig.local`
* `~/Development/dotfiles.local/psqlrc.local` (we supply a blank `psqlrc.local` to prevent `psql` from
throwing an error, but you should overwrite the file with your own copy)
For example, your `~/.aliases.local` might look like this:
# Productivity
alias todo='$EDITOR ~/.todo'
Your `~/.gitconfig.local` might look like this:
[alias]
l = log --pretty=colored
[pretty]
colored = format:%Cred%h%Creset %s %Cgreen(%cr) %C(bold blue)%an%Creset
[user]
name = Dan Croak
email = dan@thoughtbot.com
To extend your `git` hooks, create executable scripts in
`~/.git_template.local/hooks/*` files.
Your `~/.bash.local` might look like this:
# load pyenv if available
if which pyenv &>/dev/null ; then
eval "$(pyenv init -)"
fi
Credits
-------
The CivilCode Inc. dotfiles is based on and inspired by
[thoughtbot's dotfiles](https://github.com/thoughtbot/dotfiles).
thoughtbot's original work remains covered under an
[MIT License](https://github.com/thoughtbot/dotfiles/blob/a8bc74d10c62c813b625c0c8a28a996249d71c4c/LICENSE).
## About the CivilCode Collective
The [CivilCode Collective](http://www.civilcode.io), a group of freelance developers, build tailored business applications in [Elixir](http://elixir-lang.org/) and [Phoenix](http://www.phoenixframework.org/)
in Montreal, Canada.