From 6fd969d3b6d7ee492990bacf6c59eb90b4902079 Mon Sep 17 00:00:00 2001
From: Patrick Jentsch <p.jentsch@uni-bielefeld.de>
Date: Wed, 27 Mar 2019 09:40:22 +0100
Subject: [PATCH] =?UTF-8?q?README.md=20hinzuf=C3=BCgen?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..473b635
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Natural language processing
+
+This repository provides all code that is needed to build a container image for natural language processing utilising [spaCy](https://spacy.io).
+In case you don't want to build the image by yourself, there is also a prebuild image that can be used in the [registry](https://gitlab.ub.uni-bielefeld.de/sfb1288inf/nlp/container_registry).
+
+## Build the image
+
+```console
+user@machine:~$ cd <path-to-this-repository>
+user@machine:~$ docker build -t gitlab.ub.uni-bielefeld.de:4567/sfb1288inf/nlp .
+```
+
+## Starting a container
+
+```console
+user@machine:~$ docker run \
+  --name nlp-container \
+  -dit \
+  -v <your-input-directory>:/root/files_for_nlp \
+  -v <your-output-directory>:/root/files_from_nlp \
+  gitlab.ub.uni-bielefeld.de:4567/sfb1288inf/nlp
+```
+
+## Start a natural language processing run
+
+```console
+user@machine:~$ docker exec -it nlp-container \
+  nlp -i files_for_nlp -o files_from_nlp -l <language-code>
+```
+
+Where <language-code> needs to be one of the following:
+
+* de (Deutsch)
+* en (Englisch)
+* es (Spanish)
+* fr (Französisch)
+* pt (Portugisisch)
\ No newline at end of file