From 11877b63597503cfdf24897874728a7fa7ae81f6 Mon Sep 17 00:00:00 2001 From: Jonas Fonseca Date: Sat, 10 Aug 2013 23:36:12 -0400 Subject: [PATCH] Rework README to include the list of online resources Merges doc/SITES into the README file and moves the installation instructions to their own file. --- INSTALL | 2 +- Makefile | 7 +++++-- README | 42 ++++++++++++++++++++++++------------------ contrib/announcement.sh | 11 +++-------- contrib/tig.spec.in | 2 +- contrib/update-release-docs.sh | 2 +- doc/SITES | 7 ------- doc/manual.asciidoc | 4 ---- doc/tig.1.asciidoc | 6 ------ 9 files changed, 35 insertions(+), 48 deletions(-) rewrite README (82%) delete mode 100644 doc/SITES diff --git a/INSTALL b/INSTALL index 7939d33..d7d6950 100644 --- a/INSTALL +++ b/INSTALL @@ -1,5 +1,5 @@ Installation instructions -------------------------- +========================= Download a tarball from http://jonas.nitro.dk/tig/releases[] or clone the tig repository http://github.com/jonas/tig[git://github.com/jonas/tig.git]. diff --git a/Makefile b/Makefile index d32604c..03ccd23 100644 --- a/Makefile +++ b/Makefile @@ -43,7 +43,7 @@ PROGS = tig TESTS = test-graph TXTDOC = doc/tig.1.asciidoc doc/tigrc.5.asciidoc doc/manual.asciidoc NEWS README INSTALL BUGS MANDOC = doc/tig.1 doc/tigrc.5 doc/tigmanual.7 -HTMLDOC = doc/tig.1.html doc/tigrc.5.html doc/manual.html README.html NEWS.html +HTMLDOC = doc/tig.1.html doc/tigrc.5.html doc/manual.html README.html INSTALL.html NEWS.html ALLDOC = $(MANDOC) $(HTMLDOC) doc/manual.html-chunked doc/manual.pdf # Never include the release number in the tarname for tagged @@ -213,9 +213,12 @@ doc/manual.html: ASCIIDOC_FLAGS += -ainclude-manual-toc *) ref="$$ref, $$line" ;; \ esac; done | sed 's/\[\[\(.*\)\]\]/\1/' > $@ -README.html: README doc/SITES INSTALL doc/asciidoc.conf +README.html: README doc/asciidoc.conf $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article -a readme $< +INSTALL.html: INSTALL doc/asciidoc.conf + $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article $< + NEWS.html: NEWS doc/asciidoc.conf $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article $< diff --git a/README b/README dissimilarity index 82% index 1f3ddc0..d28ae89 100644 --- a/README +++ b/README @@ -1,18 +1,24 @@ -Tig: text-mode interface for git -================================ - -Tig is a git repository browser that additionally can act as a pager for output -from various git commands. - -When browsing repositories, it uses the underlying git commands to present the -user with various views, such as summarized revision 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 colorize it. - -Resources ---------- - -include::doc/SITES[] - -include::INSTALL[] +Tig: text-mode interface for git +================================ + +What is tig? +------------ +Tig is an ncurses-based text-mode interface for git. It functions mainly +as a git repository browser, but can also assist in staging changes for +commit at chunk level and act as a pager for output from various git +commands. + +Resources +--------- + + - Homepage: http://jonas.nitro.dk/tig/[] + - Manual: http://jonas.nitro.dk/tig/manual.html[] + - Tarballs: http://jonas.nitro.dk/tig/releases/[] + - Git URL: git://github.com/jonas/tig.git (master) or + git://repo.or.cz/tig.git (mirror) + - Gitweb: http://repo.or.cz/w/tig.git[] + - Q&A: http://stackoverflow.com/questions/tagged/tig[] + +Installation +------------ +For installation instructions see the link:INSTALL.html[INSTALL] file. diff --git a/contrib/announcement.sh b/contrib/announcement.sh index bd64af4..0b49d6a 100755 --- a/contrib/announcement.sh +++ b/contrib/announcement.sh @@ -17,7 +17,7 @@ root="$(git rev-parse --show-cdup)" NEWS="${root}NEWS" -SITES="${root}doc/SITES" +README="${root}README" from="$(sed -n '7,/^tig-/p' < "$NEWS" | tail -n 1 | cut -d' ' -f 1)" to="${1-HEAD}" short= @@ -30,14 +30,9 @@ $(echo "$to" | sed 's/[0-9a-zA-Z.-]/=/g') *** text for the announcement *** -What is tig? ------------- -Tig is an ncurses-based text-mode interface for git. It functions mainly -as a git repository browser, but can also assist in staging changes for -commit at chunk level and act as a pager for output from various git -commands. +$(sed -n '/What is tig?/,/^$/p' < "$README") -$(sed -n '/-/p' < "$SITES" | sed 's/[[(].*//') +$(sed -n 's/\( -.*\)[[(].*/\1/p' < "$README") Release notes ------------- diff --git a/contrib/tig.spec.in b/contrib/tig.spec.in index ff1ae00..c11fadf 100644 --- a/contrib/tig.spec.in +++ b/contrib/tig.spec.in @@ -47,7 +47,7 @@ CFLAGS="$RPM_OPT_FLAGS -DVERSION=tig-%{version}-%{release}" %files %defattr(-,root,root) %{_bindir}/* -%doc README COPYING INSTALL BUGS doc/SITES contrib/tigrc contrib/tig-completion.bash +%doc README COPYING INSTALL BUGS contrib/tigrc contrib/tig-completion.bash %{!?_without_docs: %{_mandir}/man1/*.1*} %{!?_without_docs: %{_mandir}/man5/*.5*} %{!?_without_docs: %{_mandir}/man7/*.7*} diff --git a/contrib/update-release-docs.sh b/contrib/update-release-docs.sh index a50ab1f..b4c4992 100755 --- a/contrib/update-release-docs.sh +++ b/contrib/update-release-docs.sh @@ -21,7 +21,7 @@ pageTracker._trackPageview(); mkdir -p "$DOCDIR/releases" -for file in doc/tig.1.html doc/tigrc.5.html doc/manual.html README.html NEWS.html; do +for file in doc/tig.1.html doc/tigrc.5.html doc/manual.html README.html NEWS.html INSTALL.html; do { git cat-file blob release:$file > tmp grep -v '' < tmp | grep -v '' diff --git a/doc/SITES b/doc/SITES deleted file mode 100644 index 1a67653..0000000 --- a/doc/SITES +++ /dev/null @@ -1,7 +0,0 @@ - - Homepage: http://jonas.nitro.dk/tig/[] - - Manual: http://jonas.nitro.dk/tig/manual.html[] - - Tarballs: http://jonas.nitro.dk/tig/releases/[] - - Git URL: git://github.com/jonas/tig.git (master) or - git://repo.or.cz/tig.git (mirror) - - Gitweb: http://repo.or.cz/w/tig.git[] - - Q&A: http://stackoverflow.com/questions/tagged/tig[] diff --git a/doc/manual.asciidoc b/doc/manual.asciidoc index 18a3682..5b764ec 100644 --- a/doc/manual.asciidoc +++ b/doc/manual.asciidoc @@ -604,7 +604,3 @@ ifndef::version[] - link:tig.1.asciidoc[tig(1)] - link:tigrc.5.asciidoc[tigrc(5)] endif::version[] - -Online resources: - -include::SITES.asciidoc[] diff --git a/doc/tig.1.asciidoc b/doc/tig.1.asciidoc index f590de1..e8eb08c 100644 --- a/doc/tig.1.asciidoc +++ b/doc/tig.1.asciidoc @@ -193,9 +193,3 @@ link:manual.html[the tig manual], endif::backend-xhtml11[] endif::version[] git(7) - -ifdef::version[] -Online resources: - -include::SITES[] -endif::version[] -- 2.11.4.GIT