Add some readmes to some directories

David Graeff · David Gräff
1 parent 0e6d658a
Showing 5 changed files with 53 additions and 1 deletions
CMakeLists.txt
openhantek/src/hantekdso/readme.md
openhantek/src/hantekprotocol/readme.md
openhantek/src/post/readme.md
openhantek/src/usb/readme.md
@@ -35,7 +35,7 @@ if(&quot;${CMAKE_SYSTEM}&quot; MATCHES &quot;Linux&quot;)
 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
+# 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.
+# 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.
+# 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)
+# 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.