Fixed bugs, added lots of documentation #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added more detailed comments for the options in `ws2812.h`. Added note indicating that you cannot disable gamma correction (related to JoDaNl#9).
Added lots of documentation to the README. Previously there was no documentation. - Included the fade in/out example code in the README. - Added section explaining that this library performs temporal dithering and gamma correction. Added note indicating that disabling gamma correction is currently not supported. Provided instructions for configuring the amount of temporal dithering. - Added section explaining how to connect the LED strip to the ESP8266. Previously there was no documentation which was confusing to some users (see JoDaNl#8). Added images showing the pin location for two popular ESP8266 modules. Also included an image showing a complete breadboard setup.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added lots of information to the README.
Added notes to indicate that disabling gamma correction is not yet supported. This partially resolves #define WS2812_GAMMA_CORRECTION doesn't do anything #9 because users will no longer be surprised to discover that they are unable to disable it.
Expanded comments in
ws2812.hFixed compilation error that occurred when users changed WS2812_DITHER_NUM. Fixes Cannot disable dithering #7