Skip to content

Commit 45ea474

Browse files
committed
Add information about arduino ci config
1 parent ccea67f commit 45ea474

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,20 @@ You can show Arduino CI status with a badge in your repository `README.md`
6262
> * you must replace `<OWNER>` with your GitHub username
6363
> * you must replace `<REPOSITORY>` with the name of the GitHub repository
6464
> * `Arduino%20CI` in the URL must match the `name: Arduino CI` line in the example YAML files above
65+
66+
67+
## Configuring Behavior of the Arduino CI Test Runner Itself
68+
69+
When configuring the test runner itself, it's more efficient to run `arduino_ci` locally -- it works on the same OSes as the Arduino IDE. Instructions for setting that up can be found at [the `arduino_ci` project homepage on GitHub](https://github.com/Arduino-CI/arduino_ci).
70+
71+
72+
### Writing Unit Tests
73+
74+
For information on Arduino unit testing with `arduino_ci`, see the [`REFERENCE.md` for Arduino CI's section on unit testing](https://github.com/Arduino-CI/arduino_ci/blob/master/REFERENCE.md#writing-unit-tests-in-test)
75+
76+
77+
### Testing Different Arduino Platforms
78+
79+
By default, any unit tests and example sketches are tested against a modest set of Arduino platforms. This configuration can be overridden in several specific ways; for details, see the [`REFERENCE.md` for Arduino CI's section on CI configuration](https://github.com/Arduino-CI/arduino_ci/blob/master/REFERENCE.md#indirectly-overriding-build-behavior-medium-term-use-and-advanced-options)
80+
81+
The default configuration is [available in the `arduino_ci` project](https://github.com/Arduino-CI/arduino_ci/blob/master/misc/default.yml), and shows how the platforms and packages are configured (including 3rd-party board provider information).

0 commit comments

Comments
 (0)