Updated README.md

Author: cobrce

README.md

@@ -1,3 +1,5 @@
+*Modifications added to this fork and how to customize it are below*
+
 # fastNP for STM32F103
 
 ## What is this?
@@ -65,3 +67,64 @@ For more info, take a look at demo_main.c.
 
 
 > Written with [StackEdit](https://stackedit.io/).
+
+
+# What's new in this fork
+* Modified to work as [Adalight](https://github.com/Wifsimster/adalight_ws2812) compatible with [Prismatik](https://github.com/psieg/Lightpack)
+* Using USB CDC code based on  [philrawlings' bluepill-usb-cdc-test](https://github.com/philrawlings/bluepill-usb-cdc-test)
+* Added heartbeat LED code (idea inspired from ArduinISP)
+
+## How to customize
+The code programmed for two output channels (2 WS2812 LED ribbons), on PB0 and PB1 resp., the number of LEDs in each output is defined by NUM_LEDS_OUTPUT_1 and NUM_LEDS_OUTPUT_2 resp., the number of channels is defined by WS2812_NUM_CHANNELS.
+
+### How to remove a channel (i.e use only one output)
+* Change the number of channels to 1
+```C++
+// ws2812_led.h line 45
+#define WS2812_NUM_CHANNELS     1
+```
+* You can optionally (since it's only on startup and won't have any further influenc) remove the definitions of the second channel and all code related to it
+
+```C++
+// main.c, around line 206
+#define NUM_LEDS_OUTPUT_2 80
+...
+// main.c, line 209
+struct pixel leds2[NUM_LEDS_OUTPUT_2];
+...
+// main.c, line 216
+channels[1].framebuffer = &leds2;
+channels[1].length = NUM_LEDS_OUTPUT_2 * sizeof(struct pixel);
+// main.c, line 231
+FillPixels(channels[1], colors[i]);
+```
+
+### How to add another channel
+*The output will be PB2*
+
+* Define the number of LEDs in this channel (let's say 50 LEDs) 
+```C++
+// main.c, around line 207
+#define NUM_LEDS_OUTPUT_2 50
+```
+* Define another struct 
+```C++
+// main.c, around line 210
+struct pixel leds3[NUM_LEDS_OUTPUT_3];
+```
+* Add the defined structure to channels
+```C++
+// main.c, line 218
+channels[2].framebuffer = &leds3;
+channels[2].length = NUM_LEDS_OUTPUT_3 * sizeof(struct pixel);
+```
+* Change the number of channels to 3
+```C++
+// ws2812_led.h line 45
+#define WS2812_NUM_CHANNELS     3
+```
+* Add initialization colors (optional)
+```C++
+// main.c, line 232
+FillPixels(channels[2], colors[i]);
+```

Src/main.c

@@ -240,18 +240,6 @@ int main(void)
 	uint8_t prefix[] = { 'A', 'd', 'a' }, hi, lo, chk, i;
 	while (1)
 	{
-		// for (int i = 0; i < WS2812_NUM_CHANNELS; i++)
-		// {
-		// 	for (int j = 0; j < channels[i].length; j++)
-		// 	{
-		// 		((struct pixel*)channels[i].framebuffer)[j].r = 100;
-		// 		((struct pixel*)channels[i].framebuffer)[j].g = 50;
-		// 		((struct pixel*)channels[i].framebuffer)[j].b = 0;
-		// 	}
-		// }
-
-		// DisplayChannels(channels);
-
 		// Wait for first byte of Magic Word
 
 		for (i = 0; i < sizeof prefix;)