]> mj.ucw.cz Git - xsv.git/commitdiff
README: Explain the building process slightly better
authorMartin Mares <mj@ucw.cz>
Mon, 9 Dec 2013 20:22:02 +0000 (21:22 +0100)
committerMartin Mares <mj@ucw.cz>
Mon, 9 Dec 2013 20:22:02 +0000 (21:22 +0100)
README

diff --git a/README b/README
index 99f58fd6ff2db046967317c2605dbd3693150a19..672f8150b01deb9a2575dd78467596285c6c6df2 100644 (file)
--- a/README
+++ b/README
@@ -12,12 +12,17 @@ This is a tool for processing column-oriented text files. It handles several
 formats of files including CSV, fields with fixed delimiters, fields separated
 by arbitrary whitespace, regex matching, formatting of tables and so on.
 
 formats of files including CSV, fields with fixed delimiters, fields separated
 by arbitrary whitespace, regex matching, formatting of tables and so on.
 
-See the man page for full description.
+Compilation instructions:
+
+  o  Use "make" to build the tool (xsv) and its manual page (xsv.1).
+
+  o  Use "make tests" to run the testsuite.
+
+  o  Use "make install" to install the package to /usr/local/
+     (or anywhere else if you override PREFIX).
 
 The program has been tested on Linux, but it should run on an arbitrary POSIX
 
 The program has been tested on Linux, but it should run on an arbitrary POSIX
-system with a C99 compiler and the PCRE library. Building of documentation
+system with a C99 compiler and the PCRE library. Building of the manual page
 requires AsciiDoc (any reasonably recent version should work).
 
 requires AsciiDoc (any reasonably recent version should work).
 
-Use "make" to build and "make tests" to run the test suite.
-
 All bug reports and suggestions are welcome, especially when accompanied by patches.
 All bug reports and suggestions are welcome, especially when accompanied by patches.