From a4dcb9cde25ec1eccb37d4b3ad9d776adcb372f3 Mon Sep 17 00:00:00 2001
From: Teena Hassan <thassan@techfak.uni-bielefeld.de>
Date: Mon, 9 Sep 2019 16:06:35 +0200
Subject: [PATCH] Added README.md file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c44870b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# IPAACA
+
+This repository contains the software library IPAACA developed by the Social Cognitive Systems Group at Bielefeld University. IPAACA stands for 'Incremental Processing Architecture for Artificial Conversational Agents.' The library is available in three languages: Python (Python3 compatible), C++, and Java, and for three operating systems: Linux, OS X, and Windows.
+
+## Installation
+
+### Linux
+Dependencies: Protocol Buffer (libprotobuf), Transport Protocol (**libmosquittopp**, ros, librsb)
+
+sudo apt-get install libprotobuf-dev
+sudo apt-get install libprotoc-dev
+sudo apt-get install protobuf-compiler
+sudo apt-get install mosquitto libmosquittopp-dev
+
+git clone git@gitlab.ub.uni-bielefeld.de:scs/ipaaca.git
+
+**Compiling C++ Version** 
+
+cd ipaaca/ipaacalib/cpp
+mkdir build
+cd build
+cmake ..
+make
+
+**Installing Python Version**
+
+cd ipaaca/ipaacalib/python
+python3 setup.py install --user
+
+### OS X
+
+### Windows
+
+## Usage
+
+**Python:** import ipaaca
+
+**C++:** #include "ipaaca/ipaaca.h"
+
+## History
+
+
+## Credits
+
+TODO: Write credits
+
+## License
+
+## Further Reading
+[1] IPAACA: https://scs.techfak.uni-bielefeld.de/wiki/public/ipaaca/start
+[2] Schlangen et al. "Middleware for Incremental Processing in Conversational Agents," SIGDIAL 2010. https://www.aclweb.org/anthology/W10-4308
-- 
GitLab