Reference getting started guide in all examples.

Author: davetcc

examples/eventHandling/eventHandling.ino

@@ -3,6 +3,9 @@
  * 3 then we raise an event. This is a polled event meaning that we rely on task manager polling to "roll the dice".
  * Further, there is a basic interrupt on a selected pin that is not marshalled by task manager, instead it raises
  * an event.
+ *
+ * There is a getting started guide including video available:
+ * https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
  */
 
 #include <TaskManagerIO.h>

examples/halloween/halloween.ino

@@ -5,6 +5,9 @@
  * This program just requires 4 LEDs that are attached to PWM capable pins with suitable resistors, if you use an Uno,
  * or other 5V board that would be around 330R. The LEDs randomly flash using task manager to schedule at random
  * intervals. Tested in my pumpkin and works fairly well. Enjoy!
+ *
+ * There is a getting started guide including video available:
+ * https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
  */
 #include <TaskManagerIO.h>
 

examples/longSchedule/longSchedule.ino

@@ -5,6 +5,9 @@
  *
  * You cannot create schedules over 60 minutes using the scheduleFixedRate / scheduleOnce functions, instead you use
  * the procedure below.
+ *
+ * There is a getting started guide including video available:
+ * https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
  */
 
 #include <TaskManagerIO.h>

examples/marshalInterrupt/marshalInterrupt.ino

@@ -7,6 +7,9 @@
  * NOTE: This means that there is slight latency on your code being triggered, and it should not be used for anything
  * that is even remotely time critical. For time critical items, do the work that must be done immediately in a direct
  * ISR, then trigger task manager using an event. Never add a task directly in a raw ISR.
+ *
+ * There is a getting started guide including video available:
+ * https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
  */
 
 #include <TaskManagerIO.h>

examples/mbed5NonRtos/mbedExample.cpp

@@ -3,6 +3,9 @@
 // It demonstrates raising a few tasks for scheduling and an interrupt based event.
 // WARNING - I actually have not got a non RTOS board big enough to run this.
 //
+// There is a getting started guide including video available:
+// https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
+//
 
 #include <TaskManagerIO.h>
 

examples/mbedRtos/mbedExample.cpp

@@ -3,7 +3,10 @@
  * between Arduino and mbed, so you can also look at the Arduino examples for inspiration too.
  *
  * This example shows advanced usage of taskManager covering scheduled execution, events, putting
- * events on the queue from anote
+ * events on the queue from another thread
+ *
+ * There is a getting started guide including video available:
+ * https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
  */
 
 #include <mbed.h>

examples/reentrantLocking/reentrantLocking.ino

@@ -1,3 +1,7 @@
+// Spin Locking example, not a heavily used task manager construct
+//
+// There is a getting started guide including video available:
+// https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
 
 #include <TaskManagerIO.h>
 #include <SimpleSpinLock.h>

examples/simpleTasks/simpleTasks.ino

@@ -6,6 +6,8 @@
  * that repeat at a given interval, and tasks that are executed as soon as possible
  * by task manager. We also show how to cancel a running task.
  *
+ * There is a getting started guide including video available:
+ * https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
  */
 
 // To use task manager we must include the library

examples/taskManagement/taskManagement.ino

@@ -11,6 +11,9 @@ To test the interrupt support, wire a switch to pin 2 with pull up/down. Each ch
 will cause an interrupt.
 
 Written by Dave Cherry of TheCodersCorner.com in 2017
+
+There is a getting started guide including video available:
+https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
 */
 
 #include <Arduino.h>

examples/tasksUsingExecutable/tasksUsingExecutable.ino

@@ -4,6 +4,9 @@
  * state between calls much easier and is still almost as simple to use with task manager as before.
  * It has a small RAM impact (8 bytes per vtable) on AVR boards because of their memory layout.
  * However, it has negligible impact on most 32 boards.
+ *
+ * There is a getting started guide including video available:
+ * https://www.thecoderscorner.com/products/arduino-libraries/taskmanager-io/
  */
 
 #include <TaskManagerIO.h>