Commit cc228d59b975a33630ce04496a3a4321f7b7926c

Authored by pyb
1 parent 08e041ce39
Exists in master

libad9915 add README.md

Showing 1 changed file with 45 additions and 0 deletions Side-by-side Diff

  1 +Library AD9915
  2 +===========
  3 +
  4 +C-based code for ad9915 with SPI support
  5 +
  6 +Dependencies
  7 +------------
  8 +
  9 +You must install the following dependencies:
  10 +
  11 +- [CMake](https://cmake.org/) >= 2.8
  12 +
  13 +
  14 +Building the library
  15 +-----------------
  16 +
  17 +```sh
  18 +mkdir build
  19 +cd build
  20 +cmake ..
  21 +make
  22 +make install # may require root permissions
  23 +```
  24 +
  25 +Eventually run `ldconfig` as root to cache the library
  26 +
  27 +Available Options
  28 +-----------------
  29 +
  30 +- AD9915_DEBUG: Enable the debug build type
  31 +
  32 +To use a option use this command
  33 +```sh
  34 +cmake -DAD9915_DEBUG=ON|OFF ..
  35 +```
  36 +
  37 +
  38 +Test it
  39 +----------
  40 +
  41 +```
  42 +cd test
  43 +sh run.sh
  44 +```