From 688b3404a2c880279b30f4f967ec56ef58d6d8e5 Mon Sep 17 00:00:00 2001
From: Akim Demaille <akim.demaille@gmail.com>
Date: Mon, 29 Jun 2020 07:34:42 +0200
Subject: doc: tidy the text files

* etc/README: Rename/reformat as...
* etc/README.md: this.
And ship it.
---
 etc/README    | 38 --------------------------------------
 etc/README.md | 36 ++++++++++++++++++++++++++++++++++++
 etc/local.mk  |  3 ++-
 3 files changed, 38 insertions(+), 39 deletions(-)
 delete mode 100644 etc/README
 create mode 100644 etc/README.md

(limited to 'etc')

diff --git a/etc/README b/etc/README
deleted file mode 100644
index d3122855..00000000
--- a/etc/README
+++ /dev/null
@@ -1,38 +0,0 @@
-* bench.pl
-A primitive Perl script to run benches.  Currently its only bench is
-the usual calculator: it has a lightweight processing part (but not
-null), so it is really emphasizing the cost of the whole parsing
-(including scanning and I/O).
-
-Set the envvars BISON and CC to the programs and flags you want to
-use.  They default to bison and gcc.  To run a non-installed bison
-from a tarball built in _build, I suggest the following.
-
-     BISON=_build/tests/bison CC='gcc -O2' ./bench.pl
-
-(The _build/tests/bison wrapper makes sure that _build/src/bison will
-use the tarballs' skeletons, not those already installed as a
-straightforward use of _build/src/bison would.)
-
---
-
-Copyright (C) 2006, 2009-2015, 2018-2020 Free Software Foundation, Inc.
-
-This file is part of Bison, the GNU Compiler Compiler.
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Local Variables:
-mode: outline
-End:
diff --git a/etc/README.md b/etc/README.md
new file mode 100644
index 00000000..c7c67b4a
--- /dev/null
+++ b/etc/README.md
@@ -0,0 +1,36 @@
+# bench.pl
+A primitive Perl script to run benches.  Currently its only bench is the
+usual calculator: it has a lightweight processing part (but not null), so it
+is really emphasizing the cost of the whole parsing (including scanning and
+I/O).
+
+Set the envvars `BISON` and `CC` to the programs and flags you want to use.
+They default to `bison` and `gcc`.  To run a non-installed bison from a
+tarball built in _build, I suggest the following.
+
+    BISON=_build/tests/bison CC='gcc -O2' ./bench.pl
+
+(The `_build/tests/bison` wrapper makes sure that `_build/src/bison` will
+use the tarballs' skeletons, not those already installed as a
+straightforward use of `_build/src/bison` would.)
+
+<!--
+
+Local Variables:
+mode: markdown
+fill-column: 76
+ispell-dictionary: "american"
+End:
+
+Copyright (C) 2006, 2009-2015, 2018-2020 Free Software Foundation, Inc.
+
+This file is part of Bison, the GNU Compiler Compiler.
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts.  A copy of the license is included in the "GNU Free
+Documentation License" file as part of this distribution.
+
+-->
diff --git a/etc/local.mk b/etc/local.mk
index 53985069..d03db45f 100644
--- a/etc/local.mk
+++ b/etc/local.mk
@@ -14,4 +14,5 @@
 ## You should have received a copy of the GNU General Public License
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-nodist_noinst_SCRIPTS = etc/bench.pl
+dist_noinst_DATA = %D%/README.md
+nodist_noinst_SCRIPTS = %D%/bench.pl
-- 
cgit v1.2.1