From 8969a24d40f1c08f64cc68e94e41bf23b112036a Mon Sep 17 00:00:00 2001
From: David Graeff <david.graeff@web.de>
Date: Thu, 11 Jan 2018 22:48:09 +0100
Subject: [PATCH] Add some readmes to some directories

---
 CMakeLists.txt                          |  2 +-
 openhantek/src/hantekdso/readme.md      | 24 ++++++++++++++++++++++++
 openhantek/src/hantekprotocol/readme.md | 11 +++++++++++
 openhantek/src/post/readme.md           | 10 ++++++++++
 openhantek/src/usb/readme.md            |  7 +++++++
 5 files changed, 53 insertions(+), 1 deletion(-)
 create mode 100644 openhantek/src/hantekdso/readme.md
 create mode 100644 openhantek/src/hantekprotocol/readme.md
 create mode 100644 openhantek/src/post/readme.md
 create mode 100644 openhantek/src/usb/readme.md

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6a07ecf..9d35fbb 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -35,7 +35,7 @@ if("${CMAKE_SYSTEM}" MATCHES "Linux")
 endif()
 
 # Add auxiliary files to the project, so that these files appear in VisualStudio/QtCreator
-file(GLOB_RECURSE MDFILES "docs/*.md")
+file(GLOB_RECURSE MDFILES "docs/*.md" "openhantek/*.md")
 add_custom_target(readme SOURCES readme.md ${MDFILES})
 
 # Add "cppcheck" command
diff --git a/openhantek/src/hantekdso/readme.md b/openhantek/src/hantekdso/readme.md
new file mode 100644
index 0000000..1789507
--- /dev/null
+++ b/openhantek/src/hantekdso/readme.md
@@ -0,0 +1,24 @@
+# Content
+This directory contains the heart of OpenHantek, the `HantekDSOControl` class
+and all model definitions.
+
+## HantekDSOControl
+The `HantekDSOControl` class manages all device settings (gain, offsets, channels, etc)
+and outputs `DSOSamples` via `getLastSamples()`. Observers are notified of a new set of
+available samples via the signal `samplesAvailable()`.
+Current device settings are stored in the `controlsettings` field and retriveable with the
+corresponding getter `getDeviceSettings()`.
+
+`HantekDSOControl` may only contain state fields to realize the fetch samples / modify settings loop.
+
+## Model
+A model needs a `ControlSpecification`, which
+describes what specific Hantek protocol commands are to be used. All known
+models are specified in the subdirectory `models`.
+
+# Namespace
+Relevant classes in here are in the `DSO` namespace.
+
+# Dependency
+* Files in this directory depend on structs in the `usb` folder.
+* Files in this directory depend on structs in the `hantekprotocol` folder.
diff --git a/openhantek/src/hantekprotocol/readme.md b/openhantek/src/hantekprotocol/readme.md
new file mode 100644
index 0000000..06f6b1a
--- /dev/null
+++ b/openhantek/src/hantekprotocol/readme.md
@@ -0,0 +1,11 @@
+# Content
+This directory contains all Enums, Structs, Bit- and Byte values
+that together composes the Hantek protocol (in different model variants).
+
+# Namespace
+Everything in here needs to be in the `Hantek` namespace.
+
+# Dependency
+Files in this directory may depend on structs in the `usb` folder, because
+the Hantek protocol is only defined for USB devices and some
+data structures may depend on USB specific handling.
diff --git a/openhantek/src/post/readme.md b/openhantek/src/post/readme.md
new file mode 100644
index 0000000..4d03070
--- /dev/null
+++ b/openhantek/src/post/readme.md
@@ -0,0 +1,10 @@
+# Content
+This directory contains post processing algorithms, namely
+
+* SoftwareTrigger: Determines a steady point, is used by GraphGenerator,
+* GraphGenerator: Applies all user settings (gain, offset, trigger point) and produces vertices,
+* MathChannelGenerator: Creates a math channel on top of the pysical channels
+
+# Dependency
+* Files in this directory depend on structs in the `hantekprotocol` folder.
+* Classes in here probably depend on the user settings (../viewsetting.h, ../scopesetting.h)
diff --git a/openhantek/src/usb/readme.md b/openhantek/src/usb/readme.md
new file mode 100644
index 0000000..c6c9d63
--- /dev/null
+++ b/openhantek/src/usb/readme.md
@@ -0,0 +1,7 @@
+# Content
+This directory contains all USB Command structs, firmware upload and
+USB transfer functionality.
+
+# Dependency
+Files in this directory should NOT depend on anything outside of this directory.
+An exception are classes from the `utils` folder.
--
libgit2 0.21.4