codewithher / CC-Lantern

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

[Feature] Migrate examples into new library #2

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

totally-not-frito-lays commented 8 months ago

This is the parent issue for all the issues related to migrating to the new library

Currently this fork still has meta data that suggests this is an Adafruit project. Additionally it doesn't have any custom functions. We can abstract away a lot more of the confusing elements into library functions.

Changes suggested:


I've adapted the Morse library from the official Arduino custom library documentation to blink on the Adafruit lantern core instead of writing to pins in CC-Lantern-Morse.

totally-not-frito-lays commented 7 months ago

After downloading an update from the official Adafruit package, I learned that our examples would get rewritten. We should prioritize making an independent library[^1] instead of simply forking the project.

We have two options:

  1. Continue to modify Adafruit Library as a single install
  2. Create an accessory library that is a separate install

I believe the former option is more appropriate if we were to change the way the library interacts with hardware. This would be relevant if we needed to support custom hardware.

The latter option is more appropriate in our current use case if we just write wrapper functions. This would be similar to the way that the CC-Library-Morse library is written. I believe this is the preferred option. If we can get published as an independent library, that makes it easier to install (ie. users no longer need to download and upload .zip files).

[^1]: Official Library Manager Documentation