Skip to content

[skip changelog] Add links to additional information in the examples section of the library specification #804

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 10, 2020
Merged

[skip changelog] Add links to additional information in the examples section of the library specification #804

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f948218
Move examples style guide link to examples section of the library spe…
per1234 Jul 8, 2020
27d6005
Add sketch specification link to examples section of the library spec…
per1234 Jul 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/library-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ Arduino development software supports multiple microcontroller architectures (e.

The Arduino library style guide is here : http://arduino.cc/en/Reference/APIStyleGuide

The style guide for examples is here : http://arduino.cc/en/Reference/StyleGuide

## 1.5 library format (rev. 2.2)

### Library metadata
Expand Down Expand Up @@ -102,6 +100,11 @@ Library examples must be placed in the **examples** folder. Note that the **exam

Sketches contained inside the examples folder will be shown in the Examples menu of the Arduino IDE and Arduino Web Editor.

More information:

* [Arduino sketch specification](sketch-specification.md)
* [Style guide for Arduino examples](http://arduino.cc/en/Reference/StyleGuide)

#### Extra documentation

An **extras** folder can be used by the developer to put documentation or other items to be bundled with the library. Remember that files placed inside this folder will increase the size of the library, so putting a 20MB PDF in a library that weights a few kilobytes may not be such a good idea.
Expand Down