lopsub.7: Move installation instructions from man page to README.
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 22 Apr 2019 12:48:50 +0000 (12:48 +0000)
committerAndre Noll <maan@tuebingen.mpg.de>
Mon, 22 Apr 2019 13:33:46 +0000 (15:33 +0200)
As pointed out by Adam Borowski, installation instructions don't
really belong in the man page. This commit converts the instructions
from roff format to plain text which is added at the bottom of the
existing README file.

We keep the link to the git repository though, and add a few more
links to related resources.

Requested-by: Adam Borowski <kilobyte@angband.pl>
README
lopsub.7.m4

diff --git a/README b/README
index a6ffa0b..9f77d9e 100644 (file)
--- a/README
+++ b/README
@@ -10,3 +10,27 @@ Alternatively, run
        man -l ./lopsub.7.m4
 
 to show build and installation instructions.
+
+Installation
+------------
+Build the package with
+
+       make
+
+The suite parser and the config file parser of the lopsub library are
+both generated by running flex(1), a tool for generating programs
+that perform pattern-matching on text. Hence the flex package must
+be installed for the build to succeed. Next, run
+
+       sudo make install
+
+This will install the package in /usr/local.  If you prefer to install
+as an unprivileged user in /somewhere/else, run
+
+       make PREFIX=/somewhere/else install
+
+instead. In this case, you need to specify -I/somewhere/else/include to
+compile the source files of your application and -L/somewhere/else/lib
+for linking. Alternatively, don't run make install at all and specify
+the path to the top level directory of the repository for both -I
+and -L.
index 906fa6d..75c43f1 100644 (file)
@@ -110,53 +110,6 @@ licensed with a simple all-permissive license. You are free to do
 anything you like with the generated code, including incorporating
 it into or linking it with proprietary software.
 
-.SH Installation
-Grab your copy with
-.IP
-.EX
-git clone git://git.tuebingen.mpg.de/lopsub.git
-.EE
-.PP
-Then build the package with
-.IP
-.EX
-make
-.EE
-.PP
-The suite parser and the config file parser of the
-.B lopsub
-library are both generated by running
-.MONO_ROMAN flex ,
-a tool for generating programs that perform pattern-matching on text. Hence the
-.B flex
-package must be installed for the build to succeed. Next, run
-.IP
-.EX
-sudo make install
-.EE
-.PP
-This will install the package in
-.MONO_ROMAN /usr/local .
-If you prefer to install as an unprivileged user in
-.MONO_ROMAN /somewhere/else ,
-run
-.IP
-.EX
-make PREFIX=/somewhere/else install
-.EE
-.PP
-instead. In this case, you need to specify
-.MONO -I/somewhere/else/include
-to compile the source files of your application and
-.MONO -L/somewhere/else/lib
-for linking. Alternatively, don't run
-.MONO make install
-at all and specify the path to the top level directory of the
-repository for both
-.MONO -I
-and
-.MONO_ROMAN -L .
-
 .SH Quick Start
 Compile and run the minimal example included at the end of
 .UR ./lopsub-suite.5.html
@@ -179,11 +132,26 @@ Alternatively, examine
 or
 .MONO_ROMAN lopsub.h.m4 .
 
-.SH Contact
-Email:
-.MT maan@tuebingen.mpg.de
-Andre Noll
-.ME ,
-Homepage:
+.SH Resources
+
+\(bu
+git clone URL:
+.UR git://git.tuebingen.mpg.de/lopsub.git
+.UE
+
+\(bu
+gitweb:
+.UR http://git.tuebingen.mpg.de/lopsub.git
+.UE
+
+\(bu
+The author's homepage:
 .UR http://people.tuebingen.mpg.de/maan/
 .UE
+
+\(bu
+Send feedback to
+.MT maan@tuebingen.mpg.de
+Andre Noll
+.ME
+