Improved readme
Change-Id: Iefbe769e5ff9e9a90b6b391d01ecfb037b2e04f6
diff --git a/Readme.pod b/Readme.pod
index 609470c..149dab0 100644
--- a/Readme.pod
+++ b/Readme.pod
@@ -4,7 +4,7 @@
=head1 NAME
-korapxml2krill - Merge KorapXML data and create Krill friendly documents
+korapxml2krill - Merge KorapXML data and create Krill documents
=head1 SYNOPSIS
@@ -18,7 +18,7 @@
L<KorAP::XML::Krill> is a library to convert KorAP-XML documents to files
compatible with the L<Krill|https://github.com/KorAP/Krill> indexer.
-THe C<korapxml2krill> command line tool is a simple wrapper to the library.
+The C<korapxml2krill> command line tool is a simple wrapper to the library.
=head1 INSTALLATION
@@ -28,7 +28,7 @@
$ cpanm https://github.com/KorAP/KorAP-XML-Krill
In case everything went well, the C<korapxml2krill> tool will
-be available on your command line.
+be available on your command line immediately.
=head1 ARGUMENTS
@@ -52,13 +52,14 @@
=item B<--input|-i> <directory|file>
-Directory or archive file of documents to index.
+Directory or archive file of documents to convert.
=item B<--output|-o> <directory|file>
Output folder for archive processing or
document name for single output (optional),
-writes to C<STDOUT> by default.
+writes to C<STDOUT> by default
+(in case C<output> is not mandatory due to further options).
=item B<--overwrite|-w>
@@ -72,33 +73,35 @@
=item B<--skip|-s> <foundry>[#<layer>]
-Skip specific foundries by specifying the name
-or specific layers by defining the name
-with a # in front of the foundry,
-e.g. Mate#Morpho. Alternatively you can skip C<#ALL>.
+Skip specific annotations by specifying the foundry
+(and optionally the layer with a C<#>-prefix),
+e.g. C<Mate> or C<Mate#Morpho>. Alternatively you can skip C<#ALL>.
Can be set multiple times.
=item B<--anno|-a> <foundry>#<layer>
-Allow specific annotion foundries and layers by defining them
-combining the foundry name with a C<#> and the layer name.
+Convert specific annotations by specifying the foundry
+(and optionally the layer with a C<#>-prefix),
+e.g. C<Mate> or C<Mate#Morpho>.
+Can be set multiple times.
=item B<--primary|-p>
Output primary data or not. Defaults to C<true>.
-Can be flagged using --no-primary as well.
-This is deprecated.
+Can be flagged using C<--no-primary> as well.
+This is I<deprecated>.
=item B<--jobs|-j>
Define the number of concurrent jobs in seperated forks
-for archive processing, defaults to C<0>.
-This is experimental!
+for archive processing.
+Defaults to C<0>.
+This is I<experimental>.
=item B<--human|-m>
Represent the data in an alternative human readible format.
-This is deprecated.
+This is I<deprecated>.
=item B<--pretty|-y>
@@ -106,13 +109,14 @@
=item B<--gzip|-z>
-Compress the output (expects a defined output file in single processing).
+Compress the output.
+Expects a defined C<output> file in single processing.
=item B<--sigle|-sg>
Extract the given text sigles.
-Currently only supported on C<extract>.
Can be set multiple times.
+I<Currently only supported on C<extract>.>
=item B<--log|-l>
@@ -135,15 +139,15 @@
The base foundry with paragraphs, sentences, and the text element are mandatory for
L<Krill|https://github.com/KorAP/Krill>.
-=over2
+=over 2
=item B<Base>
=over 4
-=item Paragraphs
+=item #Paragraphs
-=item Sentences
+=item #Sentences
=back
@@ -151,13 +155,13 @@
=over 4
-=item Morpho
+=item #Morpho
-=item Phrase
+=item #Phrase
-=item Sentences
+=item #Sentences
-=item Syntax
+=item #Syntax
=back
@@ -165,13 +169,13 @@
=over 4
-=item Constituency
+=item #Constituency
-=item Morpho
+=item #Morpho
-=item NamedEntities
+=item #NamedEntities
-=item Sentences
+=item #Sentences
=back
@@ -179,7 +183,7 @@
=over 4
-=item Structure
+=item #Structure
=back
@@ -187,7 +191,7 @@
=over 4
-=item Morpho
+=item #Morpho
=back
@@ -195,9 +199,9 @@
=over 4
-=item Dependency
+=item #Dependency
-=item Morpho
+=item #Morpho
=back
@@ -205,9 +209,9 @@
=over 4
-=item Morpho
+=item #Morpho
-=item Sentences
+=item #Sentences
=back
@@ -215,9 +219,9 @@
=over 4
-=item Lemma
+=item #Lemma
-=item Morpho
+=item #Morpho
=back
@@ -225,9 +229,9 @@
=over 4
-=item Morpho
+=item #Morpho
-=item Sentences
+=item #Sentences
=back
@@ -235,11 +239,11 @@
=over 4
-=item Constituency
+=item #Constituency
-=item Morpho
+=item #Morpho
-=item Sentences
+=item #Sentences
=back
@@ -257,6 +261,7 @@
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2015-2016, L<IDS Mannheim|http://www.ids-mannheim.de/>
+
Author: L<Nils Diewald|http://nils-diewald.de/>
L<KorAP::XML::Krill> is developed as part of the L<KorAP|http://korap.ids-mannheim.de/>
diff --git a/script/korapxml2krill b/script/korapxml2krill
index 35ec44c..0d7fb40 100644
--- a/script/korapxml2krill
+++ b/script/korapxml2krill
@@ -503,7 +503,7 @@
=head1 NAME
-korapxml2krill - Merge KorapXML data and create Krill friendly documents
+korapxml2krill - Merge KorapXML data and create Krill documents
=head1 SYNOPSIS
@@ -517,7 +517,7 @@
L<KorAP::XML::Krill> is a library to convert KorAP-XML documents to files
compatible with the L<Krill|https://github.com/KorAP/Krill> indexer.
-THe C<korapxml2krill> command line tool is a simple wrapper to the library.
+The C<korapxml2krill> command line tool is a simple wrapper to the library.
=head1 INSTALLATION
@@ -527,7 +527,7 @@
$ cpanm https://github.com/KorAP/KorAP-XML-Krill
In case everything went well, the C<korapxml2krill> tool will
-be available on your command line.
+be available on your command line immediately.
=head1 ARGUMENTS
@@ -551,13 +551,14 @@
=item B<--input|-i> <directory|file>
-Directory or archive file of documents to index.
+Directory or archive file of documents to convert.
=item B<--output|-o> <directory|file>
Output folder for archive processing or
document name for single output (optional),
-writes to C<STDOUT> by default.
+writes to C<STDOUT> by default
+(in case C<output> is not mandatory due to further options).
=item B<--overwrite|-w>
@@ -571,33 +572,35 @@
=item B<--skip|-s> <foundry>[#<layer>]
-Skip specific foundries by specifying the name
-or specific layers by defining the name
-with a # in front of the foundry,
-e.g. Mate#Morpho. Alternatively you can skip C<#ALL>.
+Skip specific annotations by specifying the foundry
+(and optionally the layer with a C<#>-prefix),
+e.g. C<Mate> or C<Mate#Morpho>. Alternatively you can skip C<#ALL>.
Can be set multiple times.
=item B<--anno|-a> <foundry>#<layer>
-Allow specific annotion foundries and layers by defining them
-combining the foundry name with a C<#> and the layer name.
+Convert specific annotations by specifying the foundry
+(and optionally the layer with a C<#>-prefix),
+e.g. C<Mate> or C<Mate#Morpho>.
+Can be set multiple times.
=item B<--primary|-p>
Output primary data or not. Defaults to C<true>.
-Can be flagged using --no-primary as well.
-This is deprecated.
+Can be flagged using C<--no-primary> as well.
+This is I<deprecated>.
=item B<--jobs|-j>
Define the number of concurrent jobs in seperated forks
-for archive processing, defaults to C<0>.
-This is experimental!
+for archive processing.
+Defaults to C<0>.
+This is I<experimental>.
=item B<--human|-m>
Represent the data in an alternative human readible format.
-This is deprecated.
+This is I<deprecated>.
=item B<--pretty|-y>
@@ -605,13 +608,14 @@
=item B<--gzip|-z>
-Compress the output (expects a defined output file in single processing).
+Compress the output.
+Expects a defined C<output> file in single processing.
=item B<--sigle|-sg>
Extract the given text sigles.
-Currently only supported on C<extract>.
Can be set multiple times.
+I<Currently only supported on C<extract>.>
=item B<--log|-l>
@@ -634,15 +638,15 @@
The base foundry with paragraphs, sentences, and the text element are mandatory for
L<Krill|https://github.com/KorAP/Krill>.
-=over2
+=over 2
=item B<Base>
=over 4
-=item Paragraphs
+=item #Paragraphs
-=item Sentences
+=item #Sentences
=back
@@ -650,13 +654,13 @@
=over 4
-=item Morpho
+=item #Morpho
-=item Phrase
+=item #Phrase
-=item Sentences
+=item #Sentences
-=item Syntax
+=item #Syntax
=back
@@ -664,13 +668,13 @@
=over 4
-=item Constituency
+=item #Constituency
-=item Morpho
+=item #Morpho
-=item NamedEntities
+=item #NamedEntities
-=item Sentences
+=item #Sentences
=back
@@ -678,7 +682,7 @@
=over 4
-=item Structure
+=item #Structure
=back
@@ -686,7 +690,7 @@
=over 4
-=item Morpho
+=item #Morpho
=back
@@ -694,9 +698,9 @@
=over 4
-=item Dependency
+=item #Dependency
-=item Morpho
+=item #Morpho
=back
@@ -704,9 +708,9 @@
=over 4
-=item Morpho
+=item #Morpho
-=item Sentences
+=item #Sentences
=back
@@ -714,9 +718,9 @@
=over 4
-=item Lemma
+=item #Lemma
-=item Morpho
+=item #Morpho
=back
@@ -724,9 +728,9 @@
=over 4
-=item Morpho
+=item #Morpho
-=item Sentences
+=item #Sentences
=back
@@ -734,11 +738,11 @@
=over 4
-=item Constituency
+=item #Constituency
-=item Morpho
+=item #Morpho
-=item Sentences
+=item #Sentences
=back
@@ -756,6 +760,7 @@
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2015-2016, L<IDS Mannheim|http://www.ids-mannheim.de/>
+
Author: L<Nils Diewald|http://nils-diewald.de/>
L<KorAP::XML::Krill> is developed as part of the L<KorAP|http://korap.ids-mannheim.de/>