Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit 494d5e0

Browse files
authored
Merge pull request #1561 from kopp/patch-1
document to use sub-directories for headers
2 parents f87924d + 5021c3c commit 494d5e0

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,12 @@ The following settings are as per sketch settings of the Arduino extension. You
142142
}
143143
```
144144

145+
## Known limitations/restrictions
146+
147+
- Header files to include in a `.ino` sketch have to be in a sub-directory (e.g. put a header into `foo/foo.h` and then use `#include foo/foo.h`). Without this subdirectory (e.g. `foo.h` directly next to the `.ino` file using `#include "foo.h"`), the compile step will fail. ([issue 1389](https://github.com/microsoft/vscode-arduino/issues/1389)
148+
149+
150+
145151
## Pre- and Post-Build Commands
146152
On Windows the commands run within a `cmd`-, on Linux and OSX within a `bash`-instance. Therefore your command can be anything what you can run within those shells. Instead of running a command you can invoke a script. This makes writing more complex pre-/post-build mechanisms much easier and opens up the possibility to run python or other scripting languages.
147153
The commands run within the workspace root directory and vscode-arduino sets the following environment variables:

0 commit comments

Comments
 (0)