Skip to content
Browse files

better docs on --git

  • Loading branch information...
1 parent 21924f4 commit b7e9c9d05840c9cc75e2ff65b0c70b1b33cd9649 @jaked committed May 10, 2011
Showing with 26 additions and 2 deletions.
  1. +26 −2 README.rdoc
View
28 README.rdoc
@@ -7,8 +7,32 @@ Usage:
:$ scala-bootstrapper foo
:$ sbt update test
-If you want to track scala-bootstrapper generated files in Git:
+== Git support
+
+You can track files generated by scala-bootstrapper in a Git branch,
+and later merge changes from the branch (e.g. to rename a project, or
+to upgrade to a newer version of scala-bootstrapper.
+
+To get started:
:$ scala-bootstrapper --git foo
-To update files (with a new version of scala-bootstrapper), just run it again.
+For a brand-new project (no <tt>.git</tt> directory) this will
+initialize a Git repo in the directory, generate files into the
+<tt>scala-bootstrapper</tt> branch, and merge the branch to
+<tt>master</tt>.
+
+For an existing project, this will generate files into the
+<tt>scala-bootstrapper</tt> branch, and merge it to the current branch
+*without* actually taking the changes (just making
+<tt>scala-bootstrapper</tt> a parent of the current branch to anchor
+future merges). This is to avoid clobbering files if you had
+previously run <tt>scala-bootstrapper</t> without the <tt>--git</tt>
+option (or created files some other way). If you want to merge the
+changes and manually resolve any conflicts, do
+
+ :$ git cherry-pick --no-commit scala-bootstrapper
+
+Once the <tt>scala-bootstrapper</tt> branch is created, subsequent
+runs will generate files into the branch and merge it to the current
+branch; if there are conflicts you can resolve them in the usual way.

0 comments on commit b7e9c9d

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