README

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`.