Skip to content

Commit

Permalink
Better README.
Browse files Browse the repository at this point in the history
  • Loading branch information
TomazErjavec committed Aug 13, 2020
1 parent 04bfdd6 commit 2e477d1
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,22 @@ parliamentary debates.
The proposed format is centered on storing and interchanging
linguistically annotated corpora of parliamentary data to be used in
scholarly research.

Readable documentation can be found on
[gihub.io](https://clarin-eric.github.io/parla-clarin/), while the
[project Wiki](https://github.com/clarin-eric/parla-clarin/wiki) gives
instructions on how to validate your corpus against the Parla-CLARIN
schema and how to modify the schema for your own needs.

The project contains the following folders:

* [Schema](Schema/): The TEI ODD for the Parla-CLARIN annotation
schema and derived XML schemas in in various formats (RelaxNG, W3C
schema and DTD)
* [Examples](Examples/): Examples of parliamentary debates from
various project that serve as examples of the Parla-CLARIN encoding
* [bin](bin/): Scripts for conversion and validation of the
Parla-CLARIN TEI ODD schema and supporting documents
* [docs](docs/): Documentation in HTML, automatically derived from the
Parla-CLARIN TEI ODD (and available from
[gihub.io](https://clarin-eric.github.io/parla-clarin/))
13 changes: 8 additions & 5 deletions bin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Parla-CLARIN / bin

This directory contains scripts for conversion and validation of the Parla-CLARIN TEI ODD schema and example
documents.
This directory contains scripts for conversion and validation of the
Parla-CLARIN TEI ODD schema and supporting documents.

Note that the directory should include the TEI Stylesheets, which are, however .gitgnored.
Before using the conversions, the [Stylesheets](https://github.com/TEIC/Stylesheets)
should be cloned into the directory `parla-clarin/bin/Stylesheets`.
Note that the directory should include the TEI Stylesheets, which are,
however .gitgnored.

Before using the conversions, the
[Stylesheets](https://github.com/TEIC/Stylesheets) should be cloned
into the directory `parla-clarin/bin/Stylesheets`.

0 comments on commit 2e477d1

Please sign in to comment.