]> Repositories - Adafruit_Blinka-hackapet.git/commitdiff
More readable, link to log of example test suite
authorCefn Hoile <github.com@cefn.com>
Mon, 19 Feb 2018 20:23:16 +0000 (20:23 +0000)
committerGitHub <noreply@github.com>
Mon, 19 Feb 2018 20:23:16 +0000 (20:23 +0000)
I really have to break my markdown habits!

README.rst

index 6a4fcae74984cd859809e188daaf442903f57f35..780355358fe88641da97b56b83eb4ba1c03512f3 100644 (file)
@@ -13,15 +13,12 @@ Introduction
     :target: https://travis-ci.org/adafruit/Adafruit__Micropython_Blinka
     :alt: Build Status
 
     :target: https://travis-ci.org/adafruit/Adafruit__Micropython_Blinka
     :alt: Build Status
 
-Description
-===========
-
 This repository contains a selection of packages mirroring the CircuitPython API
 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
 
 
 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.
 
 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 <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/3b2fc268d89aee6a648da456224e6d48d2476baa>`_),
 
 
 Usage Example
 =============
 
 At the time of writing (`git:3b2fc268 <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/3b2fc268d89aee6a648da456224e6d48d2476baa>`_),
-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 <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
 
 .. code-block:: python
 
 
 .. code-block:: python