From cc228d59b975a33630ce04496a3a4321f7b7926c Mon Sep 17 00:00:00 2001
From: pyb <pyb2@femto-st.fr>
Date: Tue, 2 Apr 2019 13:27:52 +0200
Subject: [PATCH] libad9915 add README.md

---
 README    |  0
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index e69de29..0000000
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..852ee50
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+Library AD9915
+===========
+
+C-based code for ad9915 with SPI support
+
+Dependencies
+------------
+
+You must install the following dependencies:
+
+- [CMake](https://cmake.org/) >= 2.8
+
+
+Building the library
+-----------------
+
+```sh
+mkdir build
+cd build
+cmake ..
+make
+make install # may require root permissions
+```
+
+Eventually run `ldconfig` as root to cache the library
+
+Available Options
+-----------------
+
+- AD9915_DEBUG: Enable the debug build type
+
+To use a option use this command
+```sh
+cmake -DAD9915_DEBUG=ON|OFF ..
+```
+
+
+Test it
+----------
+
+```
+cd test
+sh run.sh
+```
+
-- 
2.16.4