Merge branch 'jk/maint-push-progress'
[gitweb.git] / contrib / subtree / INSTALL
index 81ac702ad22f4e7116459fde665e2159842aa85a..7ab0cf450967fedbe590a25528a6600d412d7835 100644 (file)
@@ -1,22 +1,28 @@
-
 HOW TO INSTALL git-subtree
 ==========================
 
-You simply need to copy the file 'git-subtree.sh' to where
-the rest of the git scripts are stored. 
+First, build from the top source directory.
+
+Then, in contrib/subtree, run:
+
+  make
+  make install
+  make install-doc
 
-From the Git bash window just run:
+If you used configure to do the main build the git-subtree build will
+pick up those settings.  If not, you will likely have to provide a
+value for prefix:
 
-install.sh 
+  make prefix=<some dir>
+  make prefix=<some dir> install
+  make prefix=<some dir> install-doc
 
-Or if you have the full Cygwin installed, you can use make:
+To run tests first copy git-subtree to the main build area so the
+newly-built git can find it:
 
-make install
+  cp git-subtree ../..
 
-That will make a 'git subtree' (note: space instead of dash) command
-available.  See the file git-subtree.txt for more.
+Then:
 
-You can also install the man page by doing:
+  make test
 
-       make doc
-       cp git-subtree.1 /usr/share/man/man1/