X-Git-Url: https://git.ayoreis.com/hackapet/Adafruit_Blinka.git/blobdiff_plain/aeb8c0eac6635a886947e73c20ad0a08aaf9da53..e009837d76966651c948352381e37a8b6c696ec1:/README.rst diff --git a/README.rst b/README.rst old mode 100644 new mode 100755 index 7803553..07266d7 --- a/README.rst +++ b/README.rst @@ -9,8 +9,8 @@ Introduction :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 This repository contains a selection of packages mirroring the CircuitPython API @@ -18,40 +18,42 @@ on hosts running micropython. Working code exists to emulate the CircuitPython p * **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 ============= 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 +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 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 - +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 ============= -At the time of writing (`git:3b2fc268 `_), -the following sequence runs through some basic testing of the digitalio compatibility layer, which looks like `this `_ . +At the time of writing (`git:7fc1f8ab `_), +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 `_ . Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. Building locally