Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Document "DO NOT EDIT BELOW THIS LINE" convention

  • Loading branch information...
commit 52b2ee106e3c8c3ed36611e6e99f39d10a01bd4f 1 parent 0060e0a
Dan Croak authored October 21, 2012

Showing 1 changed file with 44 additions and 25 deletions. Show diff stats Hide diff stats

  1. 69  README.md
69  README.md
Source Rendered
... ...
@@ -1,32 +1,39 @@
1 1
 thoughtbot dotfiles
2 2
 ===================
3 3
 
  4
+Requirements
  5
+------------
  6
+
  7
+Set zsh as your login shell.
  8
+
  9
+    chsh -s /bin/zsh
  10
+
4 11
 Install
5 12
 -------
6 13
 
7  
-First, [fork this repo](https://github.com/thoughtbot/dotfiles#fork_box) on Github.
  14
+First, [fork this repo](/thoughtbot/dotfiles#fork_box) on Github.
8 15
 
9  
-Then, clone your Github fork (replace "your-github-name" with your Github name) onto your laptop and install it:
  16
+Then, clone your Github fork onto your laptop and install it:
10 17
 
11 18
     git clone git@github.com:your-github-name/dotfiles.git
12 19
     cd dotfiles
13 20
     ./install.sh
14 21
 
15  
-This will create symlinks for all config files in your home directory. You can
16  
-safely run this file multiple times to update.
  22
+This will create symlinks for config files in your home directory. If you
  23
+include the line "DO NOT EDIT BELOW THIS LINE" anywhere in a config file, it
  24
+will copy that file over instead of symlinking it, and it will leave
  25
+everything above that line in your local config intact.
17 26
 
18  
-There is configuration for `zsh` so switch your shell from the default `bash` to `zsh` on OS X:
19  
-
20  
-    chsh -s /bin/zsh
  27
+You can safely run `./install.sh` multiple times to update.
21 28
 
22 29
 Why fork?
23 30
 ---------
24 31
 
25  
-dotfiles are fairly personal. You should be able to modify your dotfiles, and save them in version control in your fork.
26  
-
27  
-However, the thoughtbot folks are often tweaking these dotfiles and you want to be able to get those updates.
  32
+You should be able to experiment with your own dotfiles, save them in version
  33
+control, and still get updates from `thoughtbot/dotfiles`.
28 34
 
29  
-So, your master branch is meant for your customizations and use the `upstream` branch to get thoughtbot's updates.
  35
+The `master` branch is for your customizations and the `upstream` branch is for
  36
+thoughtbot's updates.
30 37
 
31 38
 Set up the upstream branch
32 39
 --------------------------
@@ -37,22 +44,37 @@ You only have to do this once:
37 44
     git fetch upstream
38 45
     git checkout -b upstream upstream/master
39 46
 
40  
-Update thoughtbot's changes into your customizations
41  
-----------------------------------------------------
  47
+Make your own customizations
  48
+----------------------------
  49
+
  50
+Put your customizations at the top of files, separated by "DO NOT EDIT BELOW
  51
+THIS LINE."
  52
+
  53
+For example, the top of your `~/.gitconfig` might look like this:
42 54
 
43  
-You will want to customize your environment. We suggest making changes in files that are not in thoughtbot's files.
  55
+    [user]
  56
+      name = Joe Ferris
  57
+      email = jferris@thoughtbot.com
44 58
 
45  
-For example, to customize your `zsh` config, make your changes in `~/.zshenv`:
  59
+    # DO NOT EDIT BELOW THIS LINE
  60
+
  61
+    [push]
  62
+      default = current
  63
+
  64
+The top of your `~/.zlogin` might look like this:
46 65
 
47 66
     # RVM
48 67
     [[ -s '/Users/croaky/.rvm/scripts/rvm' ]] && source '/Users/croaky/.rvm/scripts/rvm'
49 68
 
  69
+    # DO NOT EDIT BELOW THIS LINE
  70
+
50 71
     # recommended by brew doctor
51 72
     export PATH="/usr/local/bin:/usr/local/sbin:$PATH"
52 73
 
53  
-Commit those kinds of things in your master branch.
  74
+Get thoughtbot's updates
  75
+------------------------
54 76
 
55  
-Then, each time you want to update thoughtbot's changes.
  77
+Each time you want to include thoughtbot's changes:
56 78
 
57 79
     git checkout upstream
58 80
     git pull
@@ -62,15 +84,12 @@ Then, each time you want to update thoughtbot's changes.
62 84
 Credits
63 85
 -------
64 86
 
65  
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
66  
-
67  
-dotfiles are maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
  87
+Thank you, [contributors](/thoughtbot/dotfiles/graphs/contributors)!
68 88
 
69  
-Thank you to all [the contributors](https://github.com/thoughtbot/dotfiles/contributors)!
  89
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
70 90
 
  91
+Dotfiles is maintained by [thoughtbot, inc](http://thoughtbot.com/community)
71 92
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
72 93
 
73  
-License
74  
--------
75  
-
76  
-dotfiles is Copyright © 2009-2012 thoughtbot, inc.. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
  94
+Dotfiles is © 2009-2012 thoughtbot, inc. It is free software and may be
  95
+redistributed under the terms specified in the MIT-LICENSE file.

0 notes on commit 52b2ee1

Please sign in to comment.
Something went wrong with that request. Please try again.