Browse Source

Update README

Joeri Exelmans 2 years ago
parent
commit
647f1b492f
2 changed files with 7 additions and 2 deletions
  1. 2 2
      README.md
  2. 5 0
      src/xopp2oml/README.md

+ 2 - 2
README.md

@@ -18,9 +18,9 @@ XOPP to OML converter
 
 Dependencies: Python3, Jinja2, xopp2py
 
-#### Entry point: xopp2oml.convert
+Entry point: xopp2oml.convert (Python script that takes as input as .xopp file and produces as output an .oml file)
 
-Python script that takes as input as .xopp file and produces as output an .oml file.
+See also: [src/xopp2oml/README.md](src/xopp2oml/README.md)
 
 
 ## Running the tests

+ 5 - 0
src/xopp2oml/README.md

@@ -0,0 +1,5 @@
+# xopp2oml - OML exporter for xopp2py
+
+This exporter generates OML descriptions that use the following vocabulary:
+
+https://msdl.uantwerpen.be/git/lucasalbertins/DTDesign/src/d070f9e9e932ad9910eaab92eabc368e7ee96058/examples/oml/CDF/src/oml/flandersmake.be/cdf/vocabulary/xopp.oml