SparkFun_APDS-9960_Sensor_Arduino_Library icon indicating copy to clipboard operation
SparkFun_APDS-9960_Sensor_Arduino_Library copied to clipboard

Improve README.md

Open per1234 opened this issue 7 years ago • 0 comments

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

per1234 avatar Jul 10 '17 16:07 per1234