INSTALL: Added installation instructions
authorRobin Green <greenrd@greenrd.org>
Sat, 9 Mar 2013 07:11:24 +0000 (9 07:11 +0000)
committerRobin Green <greenrd@greenrd.org>
Sat, 9 Mar 2013 07:11:24 +0000 (9 07:11 +0000)
INSTALL [new file with mode: 0644]
README

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..17c5ad2
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,47 @@
+                TopGit installation
+
+Direct from source
+------------------
+
+Although TopGit is essentially a bunch of shell scripts (and their
+accompanying documentation), it does require some preprocessing.
+
+Normally you can just do "make" followed by "make install", and that will
+install the tg program in your own ~/bin/ directory.  If you want to do a
+global install, you can do
+
+   # make prefix=/usr install ;# as root
+
+(or prefix=/usr/local, of course).  Just like any program suite that uses
+$prefix, the built results have some paths encoded, which are derived from
+$prefix, so "make all; make prefix=/usr install" would not work.
+
+The Makefile does not currently install the bash completion support in
+contrib/tg-completion.bash. Instructions for installing that file are at the
+top of that file.
+
+
+Other
+-----
+
+Alternatively, you can install using OS/distro-specific packages or similar
+- which should also pull in git as a dependency if you are installing on
+a machine which does not already have git installed.
+
+Note that most such packages have not yet been updated to point to the new
+TopGit repo on GitHub. Ones that have are listed below:
+
+Linux
+~~~~~
+
+* OpenSuSE: http://software.opensuse.org/download.html?project=home:arvidjaar:TopGIT&package=topgit [unofficial]
+
+Mac OS X
+~~~~~~~~
+
+none as yet
+
+FreeBSD
+~~~~~~~
+
+none as yet
\ No newline at end of file
diff --git a/README b/README
index 14e9542..b798acd 100644 (file)
--- a/README
+++ b/README
@@ -12,6 +12,11 @@ and submit them - TopGit achieves that by keeping a separate topic
 branch for each patch and providing few tools to maintain the branches.
 
 
+INSTALLATION
+------------
+See the file INSTALL.
+
+
 RATIONALE
 ---------