Improve README.md #8
Open
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
per1234
commented
Jul 10, 2017
per1234
commented
- Split "Getting Started" section into "Library Installation" and "Getting Started". This fixes the previous awkwardness of the two installation options breaking the flow to opening the example.
- Manual installation to sketchbook folder, not to the IDE installation folder. Installing to the IDE installation folder is a bad idea because the library will need to be reinstalled whenever the IDE is updated to a new version.
- Link to SparkFun's instructions for Library Manager installation.
- Use correct menu path to example. The Arduino IDE uses the name value set in library.properties.
- Trim trailing whitespace.
- Fix menu path to Port menu.
- Remove dead release links. I did find the 1.4.1 release here: https://github.com/sparkfun/APDS-9960_RGB_and_Gesture_Sensor/releases/tag/V_H1.0_L1.4.1. I would be happy to add that link to this PR on request.
- Split "Getting Started" section into "Library Installation" and "Getting Started". This fixes the previous awkwardness of the two installation options breaking the flow to opening the example. - Manual installation to sketchbook folder, not to the IDE installation folder. Installing to the IDE installation folder is a bad idea because the library will need to be reinstalled whenever the IDE is updated to a new version. - Link to SparkFun's instructions for Library Manager installation. - Use correct menu path to example. The Arduino IDE uses the name value set in library.properties. - Trim trailing whitespace. - Fix menu path to Port menu. - Remove dead release links. I did find the 1.4.1 release here: https://github.com/sparkfun/APDS-9960_RGB_and_Gesture_Sensor/releases/tag/V_H1.0_L1.4.1.
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.