Add notes about firmware compatibility of SDK version 1.1-0

korginc · Sep 17, 2019 · f0aa4fa · f0aa4fa
1 parent 4b44f63
commit f0aa4fa
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,13 @@
 
 This repository contains all the files and tools needed to build custom oscillators and effects for the [prologue](https://www.korg.com/products/synthesizers/prologue) and [minilogue xd](https://www.korg.com/products/synthesizers/minilogue_xd) synthesizers.
 
+#### Compatibility Notes
+
+In order to run user units built with SDK version 1.1-0, the following firmware versions are required:
+* prologue: >= v2.00
+* minilogue xd: >= v2.00 (to be announced)
+* Nu:Tekt NTS-1 digital: >= v1.02
+
 #### Overall Structure:
 * [platform/prologue/](platform/prologue/) : prologue specific files, templates and demo projects.
 * [platform/minilogue-xd/](platform/minilogue-xd/) : minilogue xd specific files, templates and demo projects.

diff --git a/platform/minilogue-xd/README.md b/platform/minilogue-xd/README.md
@@ -4,6 +4,10 @@
 
 All source files needed to build custom oscillators and effects for the [minilogue xd synthesizer](https://www.korg.com/products/synthesizers/minilogue_xd) exist under this directory.
 
+#### Compatibility Notes
+
+Firmware version >= 2.00 (to be announced) is required to run user units built with SDK version 1.1-0.
+
 #### Overall Structure:
  * [inc/](inc/) : Common headers.
  * [osc/](osc/) : Custom oscillator project template.

diff --git a/platform/nutekt-digital/README.md b/platform/nutekt-digital/README.md
@@ -4,6 +4,10 @@
 
 All source files needed to build custom oscillators and effects for the [NuTekt NTS-1 digital](https://www.korg.com/products/dj/nts_1) exist under this directory.
 
+#### Compatibility Notes
+
+Firmware version >= 1.02 is required to run user units built with SDK version 1.1-0.
+
 #### Overall Structure:
  * [inc/](inc/) : Common headers.
  * [osc/](osc/) : Custom oscillator project template.

diff --git a/platform/prologue/README.md b/platform/prologue/README.md
@@ -4,6 +4,10 @@
 
 All source files needed to build custom oscillators and effects for the [prologue synthesizer](https://www.korg.com/products/synthesizers/prologue) exist under this directory.
 
+#### Compatibility Notes
+
+Firmware version >= 2.00 is required to run user units built with SDK version 1.1-0.
+
 #### Overall Structure:
  * [inc/](inc/) : Common headers.
  * [osc/](osc/) : Custom oscillator project template.