README update

proycon · Mar 23, 2019 · 041d4b1 · 041d4b1
1 parent 895bac5
commit 041d4b1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/README.rst b/README.rst
@@ -22,6 +22,7 @@ A number of command-line tools are readily available for working with FoLiA, to
 - ``foliafreqlist`` -- Output a frequency list on tokenised FoLiA documents.
 - ``foliamerge`` -- Merges annotations from two or more FoLiA documents.
 - ``foliatextcontent`` -- A tool for adding or stripping text redundancy, supports adding offset information.
+- ``foliaupgrade`` -- Upgrades a document to the latest FoLiA version.
 - ``alpino2folia`` -- Convert Alpino-DS XML to FoLiA XML
 - ``dcoi2folia`` -- Convert D-Coi XML to FoLiA XML
 - ``rst2folia`` -- Convert ReStructuredText, a lightweight non-intrusive text markup language, to FoLiA, using `docutils <http://docutils.sourceforge.net/>`_.
@@ -35,7 +36,7 @@ The FoLiA tools are published to the Python Package Index and can be installed e
 
   $ pip install folia-tools
 
-Add ``sudo`` to install it globally on your system, if you install locally, we strongly
+You may need to use ``pip3`` to ensure you have the Python 3 version.  Add ``sudo`` to install it globally on your system, but we strongly
 recommend you use virtualenv to make a self-contained Python environment.
 
 The FoLiA tools are also included in our `LaMachine distribution <https://proycon.github.io/lamachine>`_ .
@@ -48,11 +49,11 @@ If ``pip`` is not yet available, install it as follows:
 
 On Debian/Ubuntu-based systems::
 
-  $ sudo apt-get install python-pip
+  $ sudo apt-get install python3-pip
 
 On RedHat-based systems::
 
-  $ yum install python-pip
+  $ yum install python3-pip
 
 On Arch Linux systems::
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,21 +11,26 @@ various ends. The following tools are currently available:
 
 * ``foliavalidator`` -- Tests if documents are valid FoLiA XML. **Always use this to test your documents if you produce your own FoLiA documents!**
 * ``foliaquery`` -- Advanced query tool that searches FoLiA documents for a specified pattern, or modifies a document according to the query. Supports FQL (FoLiA Query Language) and CQL (Corpus Query Language).
+* ``foliaeval`` -- Evaluation tool, can compute various evaluation metrics for selected annotation types, either against
+  a gold standard reference or as a measure of inter-annotated agreement.
 * ``folia2txt`` -- Convert FoLiA XML to plain text (pure text, without any annotations)
 * ``folia2annotatedtxt`` -- Like above, but produces output simple
   token annotations inline, by appending them directly to the word using a specific delimiter.
 * ``folia2columns`` -- This conversion tool reads a FoLiA XML document
   and produces a simple columned output format (including CSV) in which each token appears on one line. Note that only simple token annotations are supported and a lot of FoLiA data can not be intuitively expressed in a simple columned format!
 * ``folia2html`` -- Converts a FoLiA document to a semi-interactive HTML document, with limited support for certain token annotations.
 * ``folia2dcoi`` -- Convert FoLiA XML to D-Coi XML (only for annotations supported by D-Coi)
-* ``dcoi2folia`` -- Convert D-Coi XML (a legacy format) to FoLiA XML
-* ``conllu2folia`` -- Convert files in the `CONLL-U format <http://http://universaldependencies.org/format.html>`_ to FoLiA XML.
-* ``rst2folia`` -- Convert `ReStructuredText <http://docutils.sourceforge.net/rst.html>`_, a lightweight non-intrusive text markup language, to FoLiA, using `docutils <http://docutils.sourceforge.net/>`.
 * ``foliatree`` -- Outputs the hierarchy of a FoLiA document.
 * ``foliacat`` -- Concatenates two or more FoLiA documents.
 * ``foliamerge`` -- Merges the annotations of two or more FoLiA documents into one.
+* ``foliaid`` -- Assigns IDs to elements in FoLiA documents
+* ``foliafreqlist`` -- Output a frequency list on tokenised FoLiA documents.
 * ``foliatextcontent`` -- A tool for adding or stripping text redundancy, supports adding offset information.
 * ``foliaupgrade`` -- Upgrades a document to the latest FoLiA version.
+* ``dcoi2folia`` -- Convert D-Coi XML (a legacy format) to FoLiA XML
+* ``conllu2folia`` -- Convert files in the `CONLL-U format <http://http://universaldependencies.org/format.html>`_ to FoLiA XML.
+* ``rst2folia`` -- Convert `ReStructuredText <http://docutils.sourceforge.net/rst.html>`_, a lightweight non-intrusive text markup language, to FoLiA, using `docutils <http://docutils.sourceforge.net/>`.
+* ``alpino2folia`` -- Convert Alpino-DS XML to FoLiA XML
 
 All of these tools are written in Python 3. More tools are added as time progresses.