Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Feature] Migrate examples into new library #2

Closed
6 of 8 tasks
totally-not-frito-lays opened this issue Jan 16, 2024 · 1 comment · Fixed by #12
Closed
6 of 8 tasks

[Feature] Migrate examples into new library #2

totally-not-frito-lays opened this issue Jan 16, 2024 · 1 comment · Fixed by #12
Assignees

Comments

@totally-not-frito-lays
Copy link
Member

totally-not-frito-lays commented Jan 16, 2024

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
Copy link
Member Author

totally-not-frito-lays commented Feb 2, 2024

After downloading an update from the official Adafruit package, I learned that our examples would get rewritten. We should prioritize making an independent library1 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).

Footnotes

  1. Official Library Manager Documentation

@totally-not-frito-lays totally-not-frito-lays changed the title Refactor this fork to be more independent [Feature] Migrate examples into new library Feb 19, 2024
@totally-not-frito-lays totally-not-frito-lays transferred this issue from codewithher/CC-Library-Lantern Feb 20, 2024
@totally-not-frito-lays totally-not-frito-lays linked a pull request Mar 5, 2024 that will close this issue
5 tasks
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant