Skip to content

Conversation

@AsherThomasBabu
Copy link

No description provided.

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DONE The examples must be placed under the examples folder in a subfolder that matches the sketch name exactly:

Mouse
|_examples
   |_ButtonMouseControl
      |_ButtonMouseControl.ino

Reference:
https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#library-examples

@per1234
Copy link
Contributor

per1234 commented Mar 13, 2020

One thing to note is that this sketch already comes bundled with the Arduino IDE (and Arduino Web Editor) under File > Examples > 09.USB > Mouse.

It does make sense to bundle the examples with the library since the IDE bundled examples are not available to arduino-cli and Arduino Pro IDE users. I don't like the idea of having duplicate code to maintain, but it also could be problematic to remove the built-in sketches since there are likely tutorials that point people to that menu path. I suppose we could replace the content of the built in sketches with a comment like:

// This example has been moved to File > Examples > Mouse > ButtonMouseControl

@AsherThomasBabu
Copy link
Author

I did it thinking that there has to be a consistent codebase throughout, What you have mentioned Is one possible solution to the issue.

@per1234 per1234 dismissed their stale review March 13, 2020 10:09

Requested changes have been made

@AsherThomasBabu AsherThomasBabu requested a review from per1234 March 13, 2020 10:09
@AsherThomasBabu
Copy link
Author

@per1234 so is it ready to merge?

@per1234
Copy link
Contributor

per1234 commented Mar 13, 2020

The example itself looks good to me, but I think it would be good to have a decision made regarding how to handle the situation with the built-in examples before moving forward with adding the examples to the Mouse and Keyboard libraries.

I'm not the one to make the decisions on these things. I just added my thoughts in hope they will be of some use.

@AsherThomasBabu
Copy link
Author

@per1234 Thanks for the insight! Hoping there will be a decision soon.

@AsherThomasBabu
Copy link
Author

Oh okay! will keep in mind.

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AsherThomasBabu
Copy link
Author

@per1234 I've added the files, please let me know if there is anything else.
Thanks

@CLAassistant
Copy link

CLAassistant commented Apr 9, 2021

CLA assistant check
All committers have signed the CLA.

@per1234 per1234 linked an issue Nov 2, 2022 that may be closed by this pull request
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.

Add example sketches

3 participants