From: Cefn Hoile Date: Mon, 19 Feb 2018 20:15:58 +0000 (+0000) Subject: Update README.rst X-Git-Tag: 0.1.0~4^2~66^2~2 X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/commitdiff_plain/bb068ba36fc5d4056d1462be6e91e368f1220b32 Update README.rst --- diff --git a/README.rst b/README.rst index a018d69..6a4fcae 100644 --- a/README.rst +++ b/README.rst @@ -27,23 +27,19 @@ on hosts running micropython. At the time of writing drafts exist for Dependencies ============= -The CircuitPython compatibility layers described above are intended for devices which -are running Micropython. Given the top level packages should be provided by any standard -CircuitPython image, you shouldn't be trying to put those packages on any board -with CircuitPython already installed. +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. -However, the test suites under testing.implementation.all are by design -intended to run on either CircuitPython or the Micropython+compatibility layer, so that -conformance can be achieved. - -Similarly the test suites under testing.implementation.micropython should only be run -on Micropython and testing.implementation.circuitpython should only be run on CircuitPython +However, the test suites under *testing.implementation.all* are by design +intended to run on either CircuitPython or on Micropython+compatibility layer to prove conformance, while 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 `, +At the time of writing (`git:3b2fc268 `_), the following sequence runs through some basic testing of the digitalio compatibility layer. .. code-block:: python