]> mj.ucw.cz Git - xsv.git/blob - README
README: Explain the building process slightly better
[xsv.git] / README
1 ================================================================================
2
3                    XSV -- Swiss-Army Knife for CSV-Like Files
4
5                        (c) 2012 Martin Mares <mj@ucw.cz>
6
7        You can use and distribute this program under the terms of GPLv2.
8
9 ================================================================================
10
11 This is a tool for processing column-oriented text files. It handles several
12 formats of files including CSV, fields with fixed delimiters, fields separated
13 by arbitrary whitespace, regex matching, formatting of tables and so on.
14
15 Compilation instructions:
16
17   o  Use "make" to build the tool (xsv) and its manual page (xsv.1).
18
19   o  Use "make tests" to run the testsuite.
20
21   o  Use "make install" to install the package to /usr/local/
22      (or anywhere else if you override PREFIX).
23
24 The program has been tested on Linux, but it should run on an arbitrary POSIX
25 system with a C99 compiler and the PCRE library. Building of the manual page
26 requires AsciiDoc (any reasonably recent version should work).
27
28 All bug reports and suggestions are welcome, especially when accompanied by patches.