X-Git-Url: https://git.ayoreis.com/hackapet/Adafruit_Blinka.git/blobdiff_plain/1d399bb3171e129ffc97850946fb9e998e0383aa..a8ed516cc3b6c4cdd7a346f897aa1a520071a239:/README.rst diff --git a/README.rst b/README.rst index 37d09da..993e0a9 100644 --- a/README.rst +++ b/README.rst @@ -13,18 +13,41 @@ Introduction :target: https://travis-ci.org/adafruit/Adafruit__Micropython_Blinka :alt: Build Status -.. todo:: Describe what the library does. +This repository contains a selection of packages mirroring the CircuitPython API +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 packages + Dependencies ============= -This driver depends on: -* Micropython +The Micropython compatibility layers described above are intended to provide a CircuitPython-like API for devices which +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. + +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 ============= -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. +At the time of writing (`git:b70fd42a `_), +the following sequence runs through some basic testing of the digitalio compatibility layer... + +.. code-block:: python + + import testing + testing.main() + +A typical log from running the suites is `here `_ . + Contributing ============