Skip to content

Commit 3c2fb47

Browse files
committed
Update installation instructions
1 parent c17f47b commit 3c2fb47

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# FastLED Manager
1+
# FastLEDManager
22

3-
[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/stnkl/EverythingToolbar/blob/master/LICENSE)
3+
<!--[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/stnkl/EverythingToolbar/blob/master/LICENSE)-->
44

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.
66

77
## Features
88

99
- 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
1111
- Adjust the animation speed globally
1212
- Select any constant color via the web interface
1313
- 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
4040
### Manual Installation
4141

4242
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
4444
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`)
4747
6. Restart your Arduino IDE
4848

4949
### Using Git
5050

51-
```
51+
```bash
5252
cd ~/Arduino/libraries
5353
git clone https://github.com/stnkl/FastLEDManager.git
5454
```
5555

5656
To update to the latest version of the library
5757

58-
```
58+
```bash
5959
cd ~/Arduino/libraries/FastLEDManager && git pull
6060
```
6161

@@ -129,7 +129,7 @@ Keep in mind the following important differences to just using FastLED:
129129
- Within your animation use `FastLEDManager.numLeds` instead of `NUM_LEDS`
130130
- 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.
131131

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.
133133

134134
### Registering animations
135135

0 commit comments

Comments
 (0)