Add Readme.md and LICENSE
Change-Id: I757378f519eb66cef754f8c4aa2a72367ba4c4d9
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e7f5c14
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2020, IDS Mannheim
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..2df9990
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,89 @@
+# KorAP-XML-CoNLL-U
+
+Tool package to convert between KorAP XML format and [CoNLL-U format](https://universaldependencies.org/format.html) including token boundary information.
+
+## Description
+
+The state of the package is very preliminary. Currently, only a script `korapxml2conllu` is provided. It converts KorAP XML zip "morpho" files with POS and lemma annotations to corresponding CoNLL-U files with foundry information, text ids and token offsets in comments.
+
+**! This software is in its early stages and not stable yet! Use it on your own risk! It is very likely to be changed or replaced.**
+## Installation
+
+```shell script
+perl Makefile.PL
+make install
+```
+
+## Command Line Invocation
+
+```
+
+$ korapxml2conllu wpd17.tree_tagger.zip | head -42
+
+# foundry = tree_tagger
+# filename = WPD17/A00/00001/tree_tagger/morpho.xml
+# text_id = WPD17_A00.00001
+# start_offsets = 0 0 5 13 19 23 33 37 43 52 61 63 67 73 85 87 91 97 101 113 123 130 136 142 146 150 155 158 169 178 184 190
+# end_offsets = 191 4 12 18 22 32 36 42 51 61 62 66 72 85 86 90 96 100 112 122 129 135 141 145 149 154 157 168 177 183 190 191
+1 Alan Alan NE NE _ _ _ _ 1.000000
+2 Smithee -- NE NE _ _ _ _ 1.000000
+3 steht stehen VVFIN VVFIN _ _ _ _ 1.000000
+4 als als KOKOM KOKOM _ _ _ _ 0.995658
+5 Pseudonym Pseudonym NN NN _ _ _ _ 1.000000
+6 für für APPR APPR _ _ _ _ 1.000000
+7 einen eine ART ART _ _ _ _ 0.998238
+8 fiktiven fiktiv ADJA ADJA _ _ _ _ 1.000000
+9 Regisseur Regisseur NN NN _ _ _ _ 1.000000
+10 , , $, $, _ _ _ _ 1.000000
+11 der die ART ART _ _ _ _ 0.954604
+12 Filme Film NN NN _ _ _ _ 1.000000
+13 verantwortet verantworten VVPP VVPP _ _ _ _ 0.753983
+14 , , $, $, _ _ _ _ 1.000000
+15 bei bei APPR APPR _ _ _ _ 0.999325
+16 denen die PDS PDS _ _ _ _ 0.906725
+17 der die ART ART _ _ _ _ 0.998927
+18 eigentliche eigentlich ADJA ADJA _ _ _ _ 1.000000
+19 Regisseur Regisseur NN NN _ _ _ _ 1.000000
+20 seinen sein PPOSAT PPOSAT _ _ _ _ 1.000000
+21 Namen Name NN NN _ _ _ _ 1.000000
+22 nicht nicht PTKNEG PTKNEG _ _ _ _ 1.000000
+23 mit mit APPR APPR _ _ _ _ 0.999012
+24 dem die ART ART _ _ _ _ 0.999949
+25 Werk Werk NN NN _ _ _ _ 1.000000
+26 in in APPR APPR _ _ _ _ 1.000000
+27 Verbindung Verbindung NN NN _ _ _ _ 1.000000
+28 gebracht bringen VVPP VVPP _ _ _ _ 0.999331
+29 haben haben VAINF VAINF _ _ _ _ 0.999987
+30 möchte mögen VMFIN VMFIN _ _ _ _ 1.000000
+31 . . $. $. _ _ _ _ 1.000000
+
+# start_offsets = 192 192 196 201 205 210 216 219 223 227 237 243 246 254 255 258 260 264 271 283 292 294 302 306 309 316 319
+# end_offsets = 320 195 200 204 209 215 218 222 226 236 242 245 253 255 258 259 263 270 282 292 293 301 305 308 315 319 320
+1 Von von APPR APPR _ _ _ _ 0.999214
+2 1968 1968 CARD CARD _ _ _ _ 1.000000
+3 bis bis APPR APPR _ _ _ _ 0.861721
+
+```
+
+## Development and License
+
+**Author**:
+
+* [Marc Kupietz](https://www1.ids-mannheim.de/digspra/personal/kupietz.html)
+
+Copyright (c) 2020, [Leibniz Institute for the German Language](http://www.ids-mannheim.de/), Mannheim, Germany
+
+This package is developed as part of the [KorAP](http://korap.ids-mannheim.de/)
+Corpus Analysis Platform at the Leibniz Institute for German Language
+([IDS](http://www.ids-mannheim.de/)).
+
+It is published under the BSD 2-clause "Simplified" license.
+
+## Contributions
+
+Contributions are very welcome!
+
+Your contributions should ideally be committed via our [Gerrit server](https://korap.ids-mannheim.de/gerrit/)
+to facilitate reviewing (see [Gerrit Code Review - A Quick Introduction](https://korap.ids-mannheim.de/gerrit/Documentation/intro-quick.html)
+if you are not familiar with Gerrit). However, we are also happy to accept comments and pull requests
+via GitHub.