]> mj.ucw.cz Git - xsv.git/commitdiff
Added a README. This is hopefully the final v1.0.
authorMartin Mares <mj@ucw.cz>
Tue, 24 Jul 2012 17:21:06 +0000 (19:21 +0200)
committerMartin Mares <mj@ucw.cz>
Tue, 24 Jul 2012 17:21:06 +0000 (19:21 +0200)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..ad7f25f
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+================================================================================
+
+                  XSV -- Swiss-Army Knife for CSV-Like Files
+
+                      (c) 2012 Martin Mares <mj@ucw.cz>
+
+       You can use and distribute this program under the terms of GPLv2.
+
+================================================================================
+
+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.
+
+See the man page for full description.
+
+The program has been tested on Linux, but it should run on an arbitrary POSIX
+system with a C99 compiler. (It is possible that some GNUisms remain in the code,
+but they should be easy to fix if needed.) Building of documentation requires
+AsciiDoc (any reasonably recent version should work).