Merge pull request #207 from caternuson/iss206

[hackapet/Adafruit_Blinka.git] / README.rst

diff --git a/README.rst b/README.rst
old mode 100644 (file)
new mode 100755 (executable)
index 37d09da..07266d7
--- a/README.rst
+++ b/README.rst
@@ -9,28 +9,51 @@ Introduction
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 

-.. image:: https://travis-ci.org/adafruit/Adafruit_Micropython_Blinka.svg?branch=master
-    :target: https://travis-ci.org/adafruit/Adafruit__Micropython_Blinka
+.. image:: https://travis-ci.com/adafruit/Adafruit_Blinka.svg?branch=master
+    :target: https://travis-ci.com/adafruit/Adafruit_Blinka

     :alt: Build Status
 
     :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
+* **analogio** - analog input/output pins, using pin identities from board+microcontroller packages
+* **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
 =============
 
 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 CPython or 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 in the test/src folder under **testing.universal** are by design
+intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance.

 
 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: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
+
+    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
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
 
 Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct

-<https://github.com/adafruit/Adafruit_Micropython_Blinka/blob/master/CODE_OF_CONDUCT.md>`_
+<https://github.com/adafruit/Adafruit_Blinka/blob/master/CODE_OF_CONDUCT.md>`_

 before contributing to help this project stay welcoming.
 
 Building locally
 before contributing to help this project stay welcoming.
 
 Building locally