Add a README

Signed-off-by: David Wagner <david.wagner@intel.com>

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89700e9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# parameter-framework
+
+tl;dr: compilation instructions are at the end
+
+## Introduction
+
+WIP
+
+## Compiling
+
+Run `cmake .` then `make`.  You may then install libraries, headers and
+binaries with `make install`.  By default, they are installed under
+`/usr/local` on unix OSes; if you want to install them under a custom
+directory, you may do so by passing it to the `cmake .` command; e.g.
+`cmake -DCMAKE_INSTALL_PREFIX=/path/to/custom/install .`.