]> git.cworth.org Git - nogit/commitdiff
README: Simplify the setup instructions
authorCarl Worth <cworth@cworth.org>
Sun, 5 Jul 2020 18:47:24 +0000 (11:47 -0700)
committerCarl Worth <cworth@cworth.org>
Sun, 5 Jul 2020 18:51:06 +0000 (11:51 -0700)
Previously we were telling users to configure merge=union in
.gitattributes files. But nogit is now taking care of this itself, so
the setup instructions are now much simpler.

README

diff --git a/README b/README
index 9c4c43665fcb3d5fc36246992cd47e519186e99f..fef3192bf4b256a07ea8c1261e20adc18c172548 100644 (file)
--- a/README
+++ b/README
@@ -95,28 +95,15 @@ save it:
 Preparing git repositories for use with nogit
 =============================================
 If you're interested in setting up a parent and child repository for
-use with nogit, here's what you'll want to do:
-
-    In the parent repository
-    ------------------------
-    Add the following to .gitignore:
-       .nogit
-       .gitattributes
-       Any files to be tracked in the child nogit repository
-
-    For the child repository
-    ------------------------
-    Create a new git repository
-    Add the files to be tracked via nogit
-    Add a .gitattributes file with contents such as:
-
-       * merge=union
-
-    The * is a pattern to match the files you're tracking. You don't
-    necessarily need to use '*' you can explicitly name the files of
-    interest. But the important thing is that all files tracked by
-    nogit use the "union" merge driver (so that merges don't result in
-    conflicts requiring user intervention).
+use with nogit, there's almost nothing to it. In the child repository,
+just put all of the files you want to be treated with nogit's
+semantics. You don't need to fiddle with any .gitattributes or
+merge=union configuration. The nogit clone will do everything
+necessary for you so you get those semantics.
+
+Then, in the parent repository, you'll simply want to augment your
+.gitignore file to ignore all nogit-managed files from the child
+repository as well as the ".nogit" directory itself.
 
 Motivation
 ==========