Skip to content

Split off header file and improve readme #15

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

Closed
wants to merge 1 commit into from

Conversation

Granjow
Copy link
Contributor

@Granjow Granjow commented Sep 30, 2019

This PR updates the Readme to help the user decide when to use this library and when to use NeoPixel, and splits the lbirary from the demo code.

@bigjosh
Copy link
Owner

bigjosh commented Sep 30, 2019

Hmm... The readme changes are very helpful. Thanks!

I'm not sure how I feel about breaking out the header file. I think many Arduino people are not C people and do not really understand headers. I like having everything contained in the single INO so when you open it, everything is right there in front of you.

If I was going to break things out into a proper library, then I'd use C++ templates to make it so that you could, say, override the timing #defines with a parameter to the template function and even an abstraction for assigning the pins on different board types.

Maybe making a nice library is a new repo, with this one remaining just the simplest example code? Would you be interested in doing that?

Thoughts?

Thanks again!

@Granjow
Copy link
Contributor Author

Granjow commented Oct 1, 2019

That sounds good, yes! Are you going to create the new repository? I think I can find out how to use C++ templates, some years have passed since I have used C++ regularly, so it is time for a refresher anyway.

Do you have experience with publishing it to the official Arduino library?

@bigjosh
Copy link
Owner

bigjosh commented Oct 1, 2019

Do you have experience with publishing it to the official Arduino library?
I do not, but I do not think that is critical. It is easy for anyone to install any library these days with just a ZIP file, and it is easy to find libraries with google! :)

@Granjow
Copy link
Contributor Author

Granjow commented Oct 2, 2019

Ok. Will start working on it and also include the timings other users listed in #10!

@bigjosh
Copy link
Owner

bigjosh commented Oct 2, 2019

Replaced by #16

@bigjosh bigjosh closed this Oct 2, 2019
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

Successfully merging this pull request may close these issues.

2 participants