|
1 | | -# FastLED Manager |
| 1 | +# FastLEDManager |
2 | 2 |
|
3 | | -[](https://github.com/stnkl/EverythingToolbar/blob/master/LICENSE) |
| 3 | +<!--[](https://github.com/stnkl/EverythingToolbar/blob/master/LICENSE)--> |
4 | 4 |
|
5 | | -FastLEDManager allows you to manage all of your FastLED sketches on the ESP8266 with minimal changes to your existing code. FastLEDManager is compatible with most of the demo sketches at https://github.com/atuline/FastLED-Demos. It requires minimal knowledge about the ESP8266 platform making in an ideal playground for beginners getting started with FastLED animations. |
| 5 | +FastLEDManager allows you to manage all of your [FastLED]([FastLED](https://github.com/FastLED/FastLED)) sketches on the ESP8266 with minimal changes to your existing code. FastLEDManager is compatible with most of the demo sketches at [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos). It requires little knowledge about the ESP8266 platform making in an ideal playground for beginners getting started with FastLED animations. |
6 | 6 |
|
7 | 7 | ## Features |
8 | 8 |
|
9 | 9 | - Control multiple animations via an intuitive web interface |
10 | | -- Use hardware inputs to cycle through animations and adjust brightness |
| 10 | +- Use hardware inputs to cycle through animations and adjust the brightness |
11 | 11 | - Adjust the animation speed globally |
12 | 12 | - Select any constant color via the web interface |
13 | 13 | - Define custom numeric sliders to parameterize your animations |
@@ -40,22 +40,22 @@ FastLEDManager allows you to manage all of your FastLED sketches on the ESP8266 |
40 | 40 | ### Manual Installation |
41 | 41 |
|
42 | 42 | 1. Make sure you have installed the dependencies above |
43 | | -2. Download the desired version from the _"[releases](https://github.com/stnkl/FastLEDManager/releases)"_ page |
| 43 | +2. Download the desired version from the [releases](https://github.com/stnkl/FastLEDManager/releases) page |
44 | 44 | 3. Extract the contents of the downloaded zip file |
45 | | -4. Rename the extracted folder to _"FastLEDManager"_ |
46 | | -5. Move this folder to your libraries directory. (under Windows: `C:\Users\<username>\Documents\Arduino\libraries\`) |
| 45 | +4. Rename the extracted folder to `FastLEDManager` |
| 46 | +5. Move this folder to your libraries directory `~/Arduino/libraries`) |
47 | 47 | 6. Restart your Arduino IDE |
48 | 48 |
|
49 | 49 | ### Using Git |
50 | 50 |
|
51 | | -``` |
| 51 | +```bash |
52 | 52 | cd ~/Arduino/libraries |
53 | 53 | git clone https://github.com/stnkl/FastLEDManager.git |
54 | 54 | ``` |
55 | 55 |
|
56 | 56 | To update to the latest version of the library |
57 | 57 |
|
58 | | -``` |
| 58 | +```bash |
59 | 59 | cd ~/Arduino/libraries/FastLEDManager && git pull |
60 | 60 | ``` |
61 | 61 |
|
@@ -129,7 +129,7 @@ Keep in mind the following important differences to just using FastLED: |
129 | 129 | - Within your animation use `FastLEDManager.numLeds` instead of `NUM_LEDS` |
130 | 130 | - Every time you may want to use `FastLED` use `FastLEDManager` instead. Since `FastLEDManager` inherits from `FastLED` all member functions will be available just like before. FastLEDManager just adds some stuff on top of that. |
131 | 131 |
|
132 | | -If you want to convert an existing FastLED sketch (e.g. from https://github.com/atuline/FastLED-Demos), so it can be handled by FastLEDManager, those are the necessary changes you have to perform. |
| 132 | +If you want to convert an existing FastLED sketch (e.g. from [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos)), so it can be handled by FastLEDManager, those are the necessary changes you have to perform. |
133 | 133 |
|
134 | 134 | ### Registering animations |
135 | 135 |
|
|
0 commit comments