update README - json2tsv - JSON to TSV converter
(HTM) git clone git://git.codemadness.org/json2tsv
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit e0b9a599b21a1e85950af9f3185989d21c630970
(DIR) parent 33d5e77ed74ebe2ac9495ca3f4dbde493b26b69f
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sat, 9 Nov 2019 16:19:45 +0100
update README
- remove -n flag information. This is not something for the introduction, but
something for the manual and there is a -r flag now too.
- structure sections similar to the sfeed README.
- add list of build instructions.
- add list of dependencies and optional dependencies section.
- add author section.
Diffstat:
M README | 36 +++++++++++++++++++++++++++----
1 file changed, 32 insertions(+), 4 deletions(-)
---
(DIR) diff --git a/README b/README
@@ -1,9 +1,31 @@
-json2tsv - convert JSON to TSV
-------------------------------
+json2tsv
+--------
+
+Convert JSON to CSV.
json2tsv reads JSON data from stdin. It outputs each JSON type to a TAB-
-Separated Value format per line. The -n flag can be used to show the indices
-for array types (by default off).
+Separated Value format per line.
+
+
+Build and install
+-----------------
+
+$ make
+# make install
+
+
+Dependencies
+------------
+
+- C compiler (C99).
+- libc
+
+
+Optional dependencies
+---------------------
+
+- POSIX make(1) (for Makefile).
+- mandoc for documentation: https://mdocml.bsd.lv/
TAB-Separated Value format
@@ -65,3 +87,9 @@ License
-------
ISC, see LICENSE file.
+
+
+Author
+------
+
+Hiltjo Posthuma <hiltjo@codemadness.org>