]> code.bitgloo.com Git - clyne/stmdsp.git/commitdiff
Update README.md
authorclyne <clyne@bitgloo.com>
Sat, 17 Oct 2020 17:48:33 +0000 (13:48 -0400)
committerGitHub <noreply@github.com>
Sat, 17 Oct 2020 17:48:33 +0000 (13:48 -0400)
README.md

index 93d7082f4a76cecefca285e5991903267ff16b37..cde901ea5b24cb6639535ffd434c3381353c2ff1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,21 @@
 # stmdsp
-Code for an STM32-based DSP device.
+This is the source code for an STM32-based DSP device. The primary goal of this device is to transform signals in real-time, through a GUI for writing and uploading C++ code to the device.  
 
-**Goals:**
+The firmware for the device is written in C++, on top of the [ChibiOS](https://www.chibios.org/dokuwiki/doku.php) real-time operating system.
+
+**Features:**
+* Read in a signal from the ADC, and either pass-through or apply a filter to the signal before outputting  it over the DAC
+* Sampling rate of 96kS/s
+* Measuring of filter code in processor clock cycles
+
+**Device features:**
 * Read +/- 5V signal(s) off of at least one pin
 * Send +/- 5V signal(s) off of at least one pin
-* Perform DSP calculations (e.g. filtering) on-device
 * Communicate with a computer program to allow for the reading, writing, and transformation of signals.
 
-See the wiki for pages on each of these goals.
-
-Source code for the device's firmware is in the `source` directory. `gui` contains code for a custom GUI for the device, in C++.
+See the wiki for more information about components of the device's software and hardware.
 
-Code for using the device with Mathematica will be added soon.
+**Directory explanation:**
+Source code for the device's firmware is in the `source` directory.  
+Source code for the accompanying GUI is in `gui`.  
+Notebook files for working with the device in Mathematica are in `mathematica`.