README: rename to README_DOCS.rst

The README really contains *ALL* of the documentation and is much
more than just a "Read Me" file.

Rename it to "README_DOCS.rst" to reflect that fact and the fact
that it's kept in ".rst" format.

Update all the necessary bits to look for it in the new location.

In preparation for adding a real "Read Me", remove the "README.rst"
link and replace it with a "README.md" link.

Signed-off-by: Kyle J. McKay <[email protected]>

.gitattributes

@@ -1,7 +1,7 @@
 .gitattributes	export-ignore
 .gitignore	export-ignore
 /.mailmap	export-ignore
-/README.rst	export-ignore
+/README.md	export-ignore
 /ChangeLog	filter=changelog
 *.awk		text eol=lf
 *.mak		text eol=lf

Makefile.mak

@@ -153,7 +153,7 @@ bin-wrappers/pre-commit : hooks/pre-commit
 	echo ". '$$curdir/hooks/pre-commit'" >>"$@" && \
 	chmod a+x "$@"
 
-$(help_out): README create-help.sh polish-help-txt.pl
+$(help_out): README_DOCS.rst create-help.sh polish-help-txt.pl
 	$(QHELP)CMD="$@" && CMD="$${CMD#tg-}" && CMD="$${CMD%.txt}" && \
 	$(SHELL_PATH) ./create-help.sh "$$CMD"
 
@@ -163,14 +163,14 @@ install-doc: install-html
 
 html: topgit.html $(html_out)
 
-tg-tg.txt: README create-html-usage.pl $(commands_in)
-	$(QHELPTG)perl ./create-html-usage.pl --text < README > $@
+tg-tg.txt: README_DOCS.rst create-html-usage.pl $(commands_in)
+	$(QHELPTG)perl ./create-html-usage.pl --text < README_DOCS.rst > $@
 
-topgit.html: README create-html-usage.pl $(commands_in)
+topgit.html: README_DOCS.rst create-html-usage.pl $(commands_in)
 	$(Q)command -v "$${RST2HTML:-rst2html}" >/dev/null || \
 	{ echo "need $${RST2HTML:-rst2html} to make $@" >&2; exit 1; }
 	$(QPOUND)echo "# \$${RST2HTML:-rst2html} is \"$${RST2HTML:-rst2html}\""
-	$(QHTMLTOPGIT)perl ./create-html-usage.pl < README | "$${RST2HTML:-rst2html}" - $@ && \
+	$(QHTMLTOPGIT)perl ./create-html-usage.pl < README_DOCS.rst | "$${RST2HTML:-rst2html}" - $@ && \
 	perl -i -pe 's/&nbsp;/\&#160;/g' "$@"
 
 $(html_out): create-html.sh

create-help.sh

@@ -7,7 +7,7 @@ if [ $# -ne 1 ] ; then
 	exit 1
 fi
 
-< README awk '
+< README_DOCS.rst awk '
 	BEGIN { incommand = 0; }
 	/^tg '"$1"'$/ { incommand = 1; next; }
 	/^~/ { next; } # Ignore the title underlines.

create-html-usage.pl

@@ -1,7 +1,7 @@
 #!/usr/bin/env perl
 
-# create-html-usage.pl -- insert usage lines into README
-# Cpoyright (C) 2015,2017 Kyle J. McKay.  All rights reserved.
+# create-html-usage.pl -- insert usage lines into README_DOCS.rst
+# Copyright (C) 2015,2017,2020 Kyle J. McKay.  All rights reserved.
 # License GPLv2 or, at your option, any later version.
 
 use strict;

polish-help-txt.pl

@@ -1,7 +1,7 @@
 #!/usr/bin/env perl
 
-# create-html-usage.pl -- insert usage lines into README
-# Cpoyright (C) 2015,2017 Kyle J. McKay.
+# create-html-usage.pl -- insert usage lines into README_DOCS.rst
+# Copyright (C) 2015,2017,2020 Kyle J. McKay.
 # All rights reserved.
 # License GPLv2 or, at your option, any later version.