aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
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.