From 4e7d6d50c1ec3e281bc653cac73ac0353f61dca7 Mon Sep 17 00:00:00 2001
From: Cyprian Laskowski <cyp@cjvt.si>
Date: Wed, 30 Sep 2020 19:50:00 +0200
Subject: [PATCH] IssueID #1487: added basic readme

---
 README | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..daa1c19
--- /dev/null
+++ b/README
@@ -0,0 +1,12 @@
+Pipeline for assigning (first creating, if necessary) superbaza
+structure_ids to a file of arbitrary Slovene strings, line by line.
+
+Example usage:
+
+$ cd scripts
+$ ./setup.sh
+$ echo "velika miza" > ../tmp/strings.txt
+$ echo "kdo ne more mimo česa" >> ../tmp/strings.txt
+$ echo "pazi, avto!" >> ../tmp/strings.txt
+$ source ../venv/bin/activate
+$ python pipeline.py ../tmp/strings.txt ../tmp/output.xml