codewithher / CC-Lantern

Wrapper library for programming cultural lanterns.
GNU General Public License v3.0
0 stars 0 forks source link

`Library.properties` should be easier to search for in the IDE #30

Closed totally-not-frito-lays closed 5 months ago

totally-not-frito-lays commented 5 months ago

Describe the bug Looking up our library name in the Arduino Registry is difficult since the description is very non-specific. See attached screenshot for more info.

Additionally, the library.properties file has a link to our now deprecated library, CC-Library-Lantern.

To Reproduce Steps to reproduce the behavior:

  1. Open up Arduino IDE
  2. Move to library manager search bar
  3. Search up "CC-Library"
  4. Try to find our library

Expected behavior CC-Library should show up as a top result but currently it's difficult to find our library in the sea of libraries.

Proposed solution We fix this by updating our description to include the words "coding culture."

Current description:

name=CC-Lantern
version=1.0.0
author=Code With Her
maintainer=Ryan <ryan@codewithher.org>
sentence=Arduino library for controlling single-wire-based LED pixels and strip.
paragraph=Creating simple examples for usage in workshops off of the Adafruit library.
category=Display
url=https://github.com/codewithher/CC-Library-Lantern
architectures=*
includes=Adafruit_NeoPixel.h

Screenshots image

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context Add any other context about the problem here.

totally-not-frito-lays commented 5 months ago

Also worth noting is that the link points to the wrong repo