update README with test info
This commit is contained in:
parent
63d2bd7d0a
commit
988d1b1da9
1 changed files with 25 additions and 2 deletions
27
README.md
27
README.md
|
|
@ -1,2 +1,25 @@
|
||||||
# Adafruit_Learning_System_Guides
|

|
||||||
Smaller programs and scripts to display "inline" in Adafruit Learning System guides
|
|
||||||
|
# Introduction
|
||||||
|
|
||||||
|
This is a collection of smaller programs and scripts to display "inline" in
|
||||||
|
[Adafruit Learning System][learn] guides. Subdirectories here will generally
|
||||||
|
contain a README with a link to their corresponding guide.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
The code here is partially [checked by Travis CI][travis] against Pylint (for
|
||||||
|
CircuitPython code) or the Arduino compilation process using
|
||||||
|
[travis-ci-arduino][travis-ci-arduino].
|
||||||
|
|
||||||
|
Code in directories containing a file called `.circuitpython.skip` will be
|
||||||
|
skipped by Pylint checks.
|
||||||
|
|
||||||
|
Code in directories containing a `.[platformname].test` file, such as
|
||||||
|
`.uno.test` will be compiled against the corresponding platform.
|
||||||
|
|
||||||
|
This is a work in progress.
|
||||||
|
|
||||||
|
[learn]: https://learn.adafruit.com/
|
||||||
|
[travis]: https://travis-ci.com/adafruit/Adafruit_Learning_System_Guides/
|
||||||
|
[travis-ci-arduino]: https://github.com/adafruit/travis-ci-arduino/
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue