From 9d8a690f8f5bf420d08a4c9787fc969a6a111bdb Mon Sep 17 00:00:00 2001 From: helenasabel Date: Mon, 2 Oct 2023 22:41:30 +0200 Subject: [PATCH] docs: brief documentation --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dcc15c9..1f595c2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ # Schema -TEI schema for project documents +TEI schemas for project documents + This repo contains the schema and annotated template files to be used to enter new data while a proper form is prepared. -The schema is generated with ROMA from a ODD specification (tei-betamesaheft.xml). +## Contents + +- The main ODD specification is `tei-betamesaheft.xml`. +- `tei-betamesaheft-expanded.odd` is derived ODD (that uses `tei-betamesaheft.xml` as its source) and it’s meant to validate the expanded files generated in the app as well as file generated by other project. +- Both RELAXNG schemas, `tei-betamesaheft.rng` and`tei-betamesaheft-expanded.rng` are generated through the [TEIGarage](https://github.com/TEIC/TEIGarage) API. +- The main ODD specification is validated on CI. Also, the RELAXNG schemas are continuously updated on CI. + +## Build requirements + +- [ant](http://ant.apache.org/) version: 1.10.7 (for building from source) + +## Build instructions + +To create a XAR file with the schemas run + +``` +ant +``` + + +