Add component.mk and allow disabling Button class via Kconfig. #74

Merged
mkfrey merged 1 commits from master into master 2021-01-29 21:21:46 +03:00
mkfrey commented 2021-01-19 19:40:15 +03:00 (Migrated from github.com)

The first commit of this pull request adds a component.mk file to allow using this project as a component of esp-idf (< 4.0).

The second commit adds a Kconfig file to allow disabling the Button class using the make menuconfig tool of the esp-idf. This is useful to avoid conflicts with other libraries implementing a class with the same name, e.g. the M5Stack library.

The first commit of this pull request adds a component.mk file to allow using this project as a component of esp-idf (< 4.0). The second commit adds a Kconfig file to allow disabling the Button class using the `make menuconfig` tool of the esp-idf. This is useful to avoid conflicts with other libraries implementing a class with the same name, e.g. the M5Stack library.
thomasfredericks commented 2021-01-20 18:14:14 +03:00 (Migrated from github.com)

Hum, would it be simpler if the three classes were in separate files?

Hum, would it be simpler if the three classes were in separate files?
mkfrey commented 2021-01-21 01:56:16 +03:00 (Migrated from github.com)

I don't know if this would change much. I think it would be better to put classes with such generic names into a namespace.

I don't know if this would change much. I think it would be better to put classes with such generic names into a namespace.
thomasfredericks commented 2021-01-21 02:50:06 +03:00 (Migrated from github.com)

Since I just released Button, I will convert it to use namespaces even though it is not the «Arduino norm». It should not break user code that much... gulp

Since I just released Button, I will convert it to use namespaces even though it is not the «Arduino norm». It should not break user code that much... *gulp*
thomasfredericks commented 2021-01-24 02:07:27 +03:00 (Migrated from github.com)

Ok, can you check out the new commit? I moved Button to Bounce2 namespace (Button2::Button).

Ok, can you check out the new commit? I moved Button to Bounce2 namespace (Button2::Button).
mkfrey commented 2021-01-24 04:00:43 +03:00 (Migrated from github.com)

Looks good from a first glance, I will test it at the start of next week.

Looks good from a first glance, I will test it at the start of next week.
mkfrey commented 2021-01-29 14:58:08 +03:00 (Migrated from github.com)

Excuse my late response. The library now works fine from my perspective. I will change this merge request to only contain the component.mk file.

What I noticed when reviewing your commit is that Doxygen outputs are part of this repository and the commits. If this is what you want, I don't want to get in your way of making things. But in my opinion this causes a lot of clutter in the repository and commit history and therefore the Doxygen generated docs should not be part of the repository.

Excuse my late response. The library now works fine from my perspective. I will change this merge request to only contain the component.mk file. What I noticed when reviewing your commit is that Doxygen outputs are part of this repository and the commits. If this is what you want, I don't want to get in your way of making things. But in my opinion this causes a lot of clutter in the repository and commit history and therefore the Doxygen generated docs should not be part of the repository.
thomasfredericks commented 2021-01-29 21:23:08 +03:00 (Migrated from github.com)

Yes. I understand about the docs. But I like that everything is bundled together. Thank you for your contribution!

Yes. I understand about the docs. But I like that everything is bundled together. Thank you for your contribution!
thomasfredericks commented 2021-01-30 01:28:20 +03:00 (Migrated from github.com)

@mkfrey What would you suggest for the docs?

@mkfrey What would you suggest for the docs?
mkfrey commented 2021-01-31 01:37:26 +03:00 (Migrated from github.com)

The standard way seems to be to use Travis CI to automatically generate and commit documentation into a separate, orphaned branch "gh-pages".

The standard way seems to be to use Travis CI to automatically generate and commit documentation into a separate, orphaned branch "gh-pages".
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Max/thomasfredericks_Bounce2#74