From: Jonas Fonseca <fonseca@diku.dk>
Date: Tue, 16 May 2006 15:18:45 +0000 (+0200)
Subject: You gotta have a README file
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=b8ae93466d333ed4f0016842a7d6355f71e195fd;p=tig.git

You gotta have a README file
---

diff --git a/Makefile b/Makefile
index 90a7563..c3e2a11 100644
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,7 @@ LDFLAGS = -lcurses
 CFLAGS	= '-DVERSION="$(VERSION)"' -Wall
 DFLAGS	= -g -DDEBUG
 PROGS	= tig
-DOCS	= tig.1.txt tig.1.html tig.1
+DOCS	= tig.1.txt tig.1.html tig.1 README.html
 VERSION	= $(shell git-describe)
 
 all: $(PROGS)
@@ -39,6 +39,9 @@ tig.1.txt: tig.c
 	sed '/^[^*]*\*\*/d' | \
 	sed 's/\*\///;s/^[^*]*\* *//' > $@
 
+README.html: README
+	asciidoc -b xhtml11 -d article -f web.conf $<
+
 %.1.html : %.1.txt
 	asciidoc -b xhtml11 -d manpage $<
 
diff --git a/README b/README
new file mode 100644
index 0000000..51cbeb3
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+Tig: text-mode interface for git
+================================
+
+Tig is a git repository browser that additionally can act as a pager for output
+of various git commands.
+
+When browsing repositories, it uses the underlying git commands to present the
+user with various views, such as summarized commit log and showing the commit
+with the log message, diffstat, and the diff.
+
+Using it as a pager, it will display input from stdin and try to colorize it.
+
+Getting tig
+-----------
+
+To get tig either grab the Makefile and tig.c files from the tig home page:
+
+ - http://jonas.nitro.dk/tig/[]
+
+or clone the tig repository using the URL:
+
+ - http://jonas.nitro.dk/tig/tig.git[]
+
+Documentation files are available either at the home page or or in the above
+repository in the branch named 'docs'.
+
+Installation instructions
+-------------------------
+
+To install tig simply run:
+
+	$ make install
+
+To install documentation run:
+
+	$ make install-docs
+
+The following tools and packages are needed:
+
+`-------------------------------`----------------------------------------------
+Tool				Description
+-------------------------------------------------------------------------------
+git-core			Tig is just a frontend for git.
+ncurses				Be sure to also have development files \
+				installed. Usually they are available in a
+				separate package ending with `-dev`.
+asciidoc (>= 7.0), xmlto	For building documentation. (Optional)
+-------------------------------------------------------------------------------
+
+NOTE: You need to install the documentation for the internal help to be
+available.
diff --git a/web.conf b/web.conf
new file mode 100644
index 0000000..7ed4c3d
--- /dev/null
+++ b/web.conf
@@ -0,0 +1,5 @@
+# No header or footers for README.html
+[header]
+
+[footer]
+