aboutsummaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authormrcodetastic <12006953+mrcodetastic@users.noreply.github.com>2024-07-29 17:51:21 +0100
committerGitHub <noreply@github.com>2024-07-29 17:51:21 +0100
commitebd8e7d5894bebebe98fe01071b0c034cde91149 (patch)
tree7fcb08450c2527410b74c2cfa87803f5d920e4db /examples
parent807dd4cf9b5d3a445e33eb54d721499254dc764a (diff)
Create README.md
Diffstat (limited to 'examples')
-rw-r--r--examples/AuroraDemo/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/examples/AuroraDemo/README.md b/examples/AuroraDemo/README.md
new file mode 100644
index 0000000..2443269
--- /dev/null
+++ b/examples/AuroraDemo/README.md
@@ -0,0 +1,9 @@
+## Aurora Demo
+* This demonstrates a combination of the following libraries:
+ - "ESP32-HUB75-MatrixPanel-DMA" to send pixel data to the physical panels in combination with its in-built "VirtualMatrix" class to create a virtual display of chained panels, so the graphical effects of the Aurora demonstrations can be shown over a 'bigger' grid of physical panels acting as one big display.
+ - "GFX_Lite" to provide a simple graphics library for drawing on the virtual display.
+ - Note: GFX_Lite is a fork of AdaFruitGFX and FastLED library combined together, with a focus on simplicity and ease of use.
+
+ ## Instructions
+ * Use the serial input to advance through the patterns, or to toggle auto advance.
+ * Sending 'n' will advance to the next pattern, 'p' will go to the previous pattern. Sending 'a' will toggle auto advance on and off.