Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Restructure respository to use components as submodules #18

Open
outlandnish opened this issue Sep 15, 2020 · 3 comments
Open

Restructure respository to use components as submodules #18

outlandnish opened this issue Sep 15, 2020 · 3 comments

Comments

@outlandnish
Copy link

To use this FastLED-idf component in my code and keep up to date with your changes, I keep my own respository that tracks these changes as an IDF component here: https://github.com/intentfulmotion/FastLED-idf

This allows me to use it as a submodule in my project and not have to keep a version of this component's source in my project repository (https://github.com/intentfulmotion/firmware-amp). It's the same repository structure used by Espressif to maintain their different components.

Would you be open to breaking off the FastLED-idf and WS2812FX-idf components into their own repositories and then using them as submodules in this repository similarly?

@outlandnish outlandnish changed the title Restructure repository for the components Restructure respository to use components as submodules Sep 15, 2020
@bbulkow
Copy link
Owner

bbulkow commented Sep 27, 2020

Yes, that's a good idea.

@BorisKourt
Copy link

BorisKourt commented Oct 8, 2020

I agree with this. Structurally it might be better to move the examples 'wrapping' out of this repository, and just leave the FastLED component here. That way the bulk of the work remains here, historical changes are clearly preserved, and the examples become optional.

Essentially:

bbulkow/FastLED-idf 
  hal/
  lib8tion/
  platforms/
  ...

bbulkow/WS2812FX-idf
  CMakeLists.txt
  FX.cpp
  ...

bbulkow/FastLED-idf-Examples
  components/FastLED-idf(submodule)
  components/WS2812FX-idf(submodule)
  main/
  ...

I'd gladly PR a proposal, but sadly can't just create repos under your name! :D

(happy to help clean up the readme after though)

@n3mawashi
Copy link

Think notionally this is a good idea, but examples should stay with the respective repositories to make it easier for others to pickup and use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants