No pip-managed libraries

[hackapet/Adafruit_Blinka.git] / README.rst

diff --git a/README.rst b/README.rst
index 37d09da34225ecc6f2d9304c3fad47880ffbf08a..993e0a9c976f36b58ba2e5cb71426ccfa4715b86 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -13,18 +13,41 @@ 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
 

-.. 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
 =============
 
 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
 =============
 
 
 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 <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/b70fd42adf2b81c7f8b176decc0bec4fb93abfe9>`_),
+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 <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
+

 
 Contributing
 ============
 
 Contributing
 ============