Skip to content

Commit da658ab

Browse files
authored
[skip changelog] Document sketch filename requirements (#1287)
Previously, the Arduino Sketch Specification only documented the requirements for sketch folder names. Since the primary sketch filename must match the folder name, this appeared at a glance to be self-evident. However, sketches may consist of multiple files, and so the specification was ambiguous regarding the naming requirements for additional files.
1 parent e64bd91 commit da658ab

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Diff for: docs/sketch-specification.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ The programs that run on Arduino boards are called "sketches". This term was inh
55

66
## Sketch folders and files
77

8+
The sketch root folder name and code file names must start with a basic letter (`A`-`Z` or `a`-`z`) or number (`0`-`9`),
9+
followed by basic letters, numbers, underscores (`_`), dots (`.`) and dashes (`-`). The maximum length is 63 characters.
10+
11+
Support for names starting with a number was added in Arduino IDE 1.8.4.
12+
813
### Sketch root folder
914

1015
Because many Arduino sketches only contain a single .ino file, it's easy to think of that file as the sketch. However,
1116
it is the folder that is the sketch. The reason is that sketches may consist of multiple code files and the folder is
1217
what groups those files into a single program.
1318

14-
The sketch root folder name must start with a basic letter (`A`-`Z` or `a`-`z`) or number (`0`-`9`), followed by basic
15-
letters, numbers, underscores (`_`), dots (`.`) and dashes (`-`). The maximum length is 63 characters.
16-
17-
Support for sketch folder names starting with a number was added in Arduino IDE 1.8.4.
18-
1919
### Primary sketch file
2020

2121
Every sketch must contain a `.ino` file with a file name matching the sketch root folder name.

0 commit comments

Comments
 (0)