From 10636f8014079a0c8a73dae92ab6366d95d251be Mon Sep 17 00:00:00 2001
From: Ilya Elenskiy <elenskiy.ilya@gmail.com>
Date: Wed, 15 Apr 2020 21:34:31 +0200
Subject: [PATCH] README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..320e7fb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# On-board peripheral libraries for EMG DMM boards
+ 
+See [DMM-Demo](https://teach.emg.ing.tu-bs.de/git/dmm/dmm-demo) for usage and
+board definitions.
+ 
+## PlatformIO
+Include into project by adding to `platformio.ini`:
+```
+[env]
+...
+lib_deps = 
+  git@teach.emg.ing.tu-bs.de:dmm/dmm-libs.git
+
+```
+ 
+By default, the libraries will be downloaded into the hidden workspace folder. 
+For easier inspection, you can change the directory to make it browsable by 
+adding:
+```
+[platformio]
+default_envs = release
+libdeps_dir = depends
+```
+
+You should avoid uploading PIO-managed external libraries into you project's 
+git. Therefore you should also add `depends` into your `.gitignore`.