Merge pull request #544 from tekktrik/doc/update-readme

[hackapet/Adafruit_Blinka.git] / README.rst

diff --git a/README.rst b/README.rst
index 40df1a97b8ed2197ea54b64aa0a611136aa30b58..5e9c020b8301a04ebb53dbcbc2e2dedba4ac8c6b 100755 (executable)
--- a/README.rst
+++ b/README.rst
@@ -17,16 +17,23 @@ Introduction
     :target: https://github.com/psf/black
     :alt: Code Style: Black
 
     :target: https://github.com/psf/black
     :alt: Code Style: Black
 

-This repository contains a selection of packages mirroring the CircuitPython API
-on hosts running micropython. Working code exists to emulate the CircuitPython packages;
+This repository contains a selection of packages emulating the CircuitPython API
+for devices or hosts running CPython or MicroPython. Working code exists to emulate these CircuitPython packages:

 
 

-* **board** - breakout-specific pin identities
-* **microcontroller** - chip-specific pin identities
+* **_typing** - (Legacy) subset of types for C-level protocols

 * **analogio** - analog input/output pins, using pin identities from board+microcontroller packages
 * **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
 * **bitbangio** - software-driven interfaces for I2C, SPI

+* **board** - breakout-specific pin identities

 * **busio** - hardware-driven interfaces for I2C, SPI, UART
 * **busio** - hardware-driven interfaces for I2C, SPI, UART

+* **circuitpython_typing** - Subset of types for C-level protocols
+* **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages
+* **keypad** - support for scanning keys and key matrices
+* **microcontroller** - chip-specific pin identities
+* **micropython** - MicroPython-specific module
+* **neopixel_write** - low-level interface to NeoPixels

 * **pulseio** - contains classes that provide access to basic pulse IO (PWM)
 * **pulseio** - contains classes that provide access to basic pulse IO (PWM)

+* **pwmio** - contains classes that provide access to basic pulse IO (PWM)
+* **rainbowio** - provides the colorwheel() function

 
 For details, see the `Blinka API reference
 <https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.
 
 For details, see the `Blinka API reference
 <https://circuitpython.readthedocs.io/projects/blinka/en/latest/index.html>`_.


@@ -34,12 +41,14 @@ For details, see the `Blinka API reference
 Dependencies
 =============
 
 Dependencies
 =============
 

-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 emulation described above is 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
 
 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.
+intended to run on *either* CircuitPython *or* CPython/Micropython+compatibility layer to prove conformance.

 
 Installing from PyPI
 =====================
 
 Installing from PyPI
 =====================