summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKatolaZ <katolaz@freaknet.org>2020-01-04 02:08:24 +0000
committerKatolaZ <katolaz@freaknet.org>2020-01-04 02:08:24 +0000
commite555494626790aabcb838227d8e7115bf3081da8 (patch)
tree4dbafe66ac001c65486831d4f268a6a0d1ee949c /README.md
parent6b04af1604ce0e04acf9b0bb2529d2ca53f4c8fc (diff)
add minimal README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5d7fd47
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+xml2tsv
+=======
+
+This is a simple xml-to-tsv converter written in C and based on the
+xmlparser library by Hiltjo Posthuma.
+
+The filter reads an XML file from stdin and writes a
+tab-separated-values file on stdout. For instance, the XML content
+below:
+
+ <!DOCTYPE html>
+ <html>
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <!-- FOR THE CURIOUS: This site was made by @thebarrytone. Don't tell my mom. -->
+
+ <title>Motherfucking Website</title>
+ </head>
+
+ <body>
+ <header>
+ <h1>This is a motherfucking website.</h1>
+ <aside>And it's fucking perfect.</aside>
+ </header>
+ </body>
+ </html>
+
+is transformed in the following lines:
+
+ /html
+ /html/head
+ /html/head/meta charset=utf-8
+ /html/head
+ /html/head/meta name=viewport content=width=device-width, initial-scale=1
+ /html/head \n \n
+ /html/head/title Motherfucking Website
+ /html/body
+ /html/body/header
+ /html/body/header/h1 This is a motherfucking website.
+ /html/body/header/aside And it's fucking perfect.
+
+Customisation
+=============
+
+It is possible to customise several aspects of the output by changing
+values in `config.h`. Please see the comments within that file for more
+details.
+
+Copying
+=======
+
+`xml2tsv` is (c) 2020 by Vincenzo "KatolaZ" Nicosia. It can be used,
+distributed, modified, and redistributed under the terms of the ISC
+License. See the file LICENSE for more details.