From 8a6d4b06f2291c363f3dea17837ed20893852453 Mon Sep 17 00:00:00 2001
From: Markus Mittendrein <git@maxmitti.tk>
Date: Wed, 9 Sep 2015 19:00:56 +0200
Subject: Cleanup repo with some directories

---
 src/libcommuni/INSTALL | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 src/libcommuni/INSTALL

(limited to 'src/libcommuni/INSTALL')

diff --git a/src/libcommuni/INSTALL b/src/libcommuni/INSTALL
new file mode 100644
index 0000000..358a799
--- /dev/null
+++ b/src/libcommuni/INSTALL
@@ -0,0 +1,26 @@
+1. qmake
+2. make
+3. sudo make install
+4. CONFIG += communi
+5. enjoy!
+
+Build config
+------------
+The default build config is resolved by qmake. To build Communi
+specifically in release or debug mode, you may pass additional
+"-config release" or "-config debug" parameters to qmake, respectively.
+Furthermore, in order to build a static version of Communi, you
+may pass "-config static".
+
+uchardet vs. ICU
+----------------
+The default encoding detection backend is uchardet. It is bundled
+with Communi and therefore requires no special build configuration.
+In order to configure Communi with the ICU encoding detection backend,
+pass "-config icu" parameters to qmake. This requires that the ICU
+libraries are installed on the system.
+
+Example
+-------
+A static library in release mode:
+qmake -config static -config release
-- 
cgit v1.2.3-54-g00ecf