Have Travis install requirements for sphinx

[hackapet/Adafruit_Blinka.git] / README.rst

diff --git a/README.rst b/README.rst
index 780355358fe88641da97b56b83eb4ba1c03512f3..127131d434ec12a81a2c83b3c4dd97d0a160b003 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -19,6 +19,9 @@ on hosts running micropython. Working code exists to emulate the CircuitPython p
 * **board** - breakout-specific pin identities
 * **microcontroller** - chip-specific pin identities
 * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
+* **bitbangio** - software-driven interfaces for I2C, SPI
+* **busio** - hardware-driven interfaces for I2C, SPI, UART
+* **time** * - substitute functions monkey-patched to time module
 
 
 Dependencies
@@ -28,23 +31,21 @@ 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.
 
-The test suites under **testing.implementation.all** are by design
+The test suites in the test/src folder under **testing.universal** 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>`_),
-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>`_ .
+At the time of writing (`git:7fc1f8ab <https://github.com/cefn/Adafruit_Micropython_Blinka/tree/7fc1f8ab477124628a5afebbf6826005955805f9>`_),
+the following sequence runs through some basic testing of the digitalio compatibility layer... 
 
 .. code-block:: python
 
-    import testing
-    testing.main()
+    from testing import test_module_name
+    test_module_name("testing.universal.digitalio")
+
+An example log from running the suites is `here <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
 
 
 Contributing