Add directory structure description in README file 20/157020/2
authorAdam Malinowski <a.malinowsk2@partner.samsung.com>
Mon, 23 Oct 2017 06:34:32 +0000 (08:34 +0200)
committerAdam Malinowski <a.malinowsk2@partner.samsung.com>
Mon, 23 Oct 2017 11:47:09 +0000 (13:47 +0200)
Change-Id: If4e6be3c5cf7e8593941aefe77eaa1a10b57e06a

README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..ba78d7b
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+Directory structure:
+
+.
+│
+└── doc - overall documentation for all of the components of MuxPi
+│
+└── hw - MuxPi board design and fabrication files
+│
+└── sw - MuxPi's software
+    │
+    └── attiny - firmware for ATtiny10 microcontroller (watchdog)
+    │
+    └── cortex - firmware for STM32F030 (controller)
+    │
+    └── nanopi - configs, scripts, tools, OS recipes, etc. for NanoPi NEO
+        │
+        └── config - ansible files for configuring NanoPi NEO
+        │
+        └── os - recipes and files needed to create or download operating system for NanoPi NEO
+        │
+        └── stm - tools/libs for communicating with STM32F030 microntroller