:target: https://travis-ci.org/adafruit/Adafruit__Micropython_Blinka
:alt: Build Status
-.. todo:: Describe what the library does.
+Description
+===========
+
+This repository contains a selection of packages mirroring the CircuitPython API
+on hosts running micropython. At the time of writing drafts exist for
+
+* board - breakout-specific pin identities
+* microcontroller - chip-specific pin identities
+* digitalio - digital input/output pins, using pin identities from board/microcontroller
+
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.
+
+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
+
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:3b2fc268 <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/3b2fc268d89aee6a648da456224e6d48d2476baa>`_),
+the following sequence runs through some basic testing of the digitalio compatibility layer.
+
+.. code-block:: python
+
+ import testing
+ testing.main()
+
Contributing
============
projects / Adafruit_Blinka-hackapet.git / blobdiff