From 988d1b1da95b65bfd28c1203f4e30a6b4291b3d6 Mon Sep 17 00:00:00 2001 From: Brennen Bearnes Date: Thu, 10 Jan 2019 13:13:35 -0700 Subject: [PATCH] update README with test info --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 540798fa..debb8a04 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# Adafruit_Learning_System_Guides -Smaller programs and scripts to display "inline" in Adafruit Learning System guides +![build status](https://travis-ci.com/adafruit/Adafruit_Learning_System_Guides.svg?branch=master "Build Status") + +# 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/