diff --git a/README.md b/README.md index a2bfcd7..e7de3d8 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,18 @@ Pipeline for parsing a list of arbitrary Slovene strings and assigning each to a syntactic structure in the DDD database, generating provisional new structures if necessary. -## Setup +## Installation -Most of the scripts come from other repositories and python libraries. -Run the set-up script: +Installation requires the [CLASSLA](https://github.com/clarinsi/classla) standard_jos models, as +well as (for now) the wani.py script from +[luscenje_struktur](https://gitea.cjvt.si/ozbolt/luscenje_struktur): -``` -$ scripts/setup.sh -``` + pip install . + python -c "import classla; classla.download('sl', dir='resources/classla', type='standard_jos')" + curl -o resources/wani.py https://gitea.cjvt.si/ozbolt/luscenje_struktur/raw/branch/master/wani.py + +The classla directory and wani.py file do not necessarily need to be placed under resources/, but +the wrapper script scripts/process.py assumes that they are. ## Usage