From: Cefn Hoile Date: Mon, 19 Feb 2018 20:23:16 +0000 (+0000) Subject: More readable, link to log of example test suite X-Git-Tag: 0.1.0~4^2~66^2~1 X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/commitdiff_plain/aeb8c0eac6635a886947e73c20ad0a08aaf9da53?ds=sidebyside More readable, link to log of example test suite I really have to break my markdown habits! --- diff --git a/README.rst b/README.rst index 6a4fcae..7803553 100644 --- a/README.rst +++ b/README.rst @@ -13,15 +13,12 @@ Introduction :target: https://travis-ci.org/adafruit/Adafruit__Micropython_Blinka :alt: Build Status -Description -=========== - This repository contains a selection of packages mirroring the CircuitPython API -on hosts running micropython. At the time of writing drafts exist for +on hosts running micropython. Working code exists to emulate the CircuitPython packages; -* board - breakout-specific pin identities -* microcontroller - chip-specific pin identities -* digitalio - digital input/output pins, using pin identities from board/microcontroller +* **board** - breakout-specific pin identities +* **microcontroller** - chip-specific pin identities +* **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages Dependencies @@ -31,16 +28,18 @@ The Micropython compatibility layers described above are intended to provide a C are running Micropython. Since corresponding packages should be built-in to any standard CircuitPython image, they have no value on a device already running CircuitPython and would likely conflict in unhappy ways. -However, the test suites under *testing.implementation.all* are by design -intended to run on either CircuitPython or on Micropython+compatibility layer to prove conformance, while the test suites under *testing.implementation.micropython* will only run -on Micropython and *testing.implementation.circuitpython* will only run on CircuitPython +The test suites under **testing.implementation.all** are by design +intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance. + +The test suites under **testing.implementation.micropython** will only run +on Micropython and **testing.implementation.circuitpython** will only run on CircuitPython Usage Example ============= At the time of writing (`git:3b2fc268 `_), -the following sequence runs through some basic testing of the digitalio compatibility layer. +the following sequence runs through some basic testing of the digitalio compatibility layer, which looks like `this `_ . .. code-block:: python