From 4be8806b603735f84796f876def792c9afa93400 Mon Sep 17 00:00:00 2001
From: Oskari Timperi <oswjk@users.noreply.github.com>
Date: Sun, 12 Feb 2017 17:25:40 +0200
Subject: Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0603f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# mqtt
+
+A simple MQTT library written in C.
+
+# Building
+
+Building the library requires CMake and a C compiler.
+
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ make
+
+# Creating the single file library
+
+Creating the single file library requires python (both 2 and 3 are ok).
+
+Execute in the build directory you created above:
+
+    $ cmake -DMQTT_AMALGAMATE=ON .
+    $ make amalgamate
+
+Now the amalgamation (`mqtt.c` and `mqtt.h`) is found in `<project_root>/amalgamation` directory.
-- 
cgit v1.2.3