Docs on adding new plugins

muvox-io / euphonium

Tiny audio platform

GNU Affero General Public License v3.0

96 stars 15 forks source link

Docs on adding new plugins #56

Closed jdthorpe closed 1 year ago

jdthorpe commented 1 year ago

These are basically my notes on creating a new plugin that I threw together as I tried to understand the application. Probably lots of typos and a few errors, but hopefully a good place to start...

jdthorpe commented 1 year ago

[x] Importing external components (git repos) should be in line with the ESP-IDF best practices ( e.g. cloning into PROJECT_DIR/components, or adding submodules to the EXTRA_COMPONENT_DIRS) instead of add_subdirectory(...)
[x] Probably should at least highlight how the runTask() method can be used to manage periodic tasks

feelfreelinux commented 1 year ago

Thanks a lot for this! Sorry for late reply - was on vacation for a bit. Currently im in process of rewriting the plugins system a little bit - adding packaging, and such, so I decided to wait a bit with exactly describing now its supposed to work. Those notes however, are still really useful :)

feelfreelinux commented 1 year ago

I'm really impressed to the extend in which you were able to understand the architecture of this!

feelfreelinux commented 1 year ago

Hi, so far - this is an amazing addition :) I'll probably make some edits due to me writing a rewrite of some parts of the system.

Sorry for the long delay, thanks a lot!