diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/common_hal.md | 3 | ||||
| -rw-r--r-- | docs/design_guide.rst | 15 | ||||
| -rw-r--r-- | docs/drivers.rst | 2 |
3 files changed, 11 insertions, 9 deletions
diff --git a/docs/common_hal.md b/docs/common_hal.md index ee2105ba1..024c1582c 100644 --- a/docs/common_hal.md +++ b/docs/common_hal.md @@ -83,4 +83,5 @@ The last step is actually implementing each function in a port specific way. I c ### Testing Woohoo! You are almost done. After you implement everything, lots of drivers and sample code should just work. There are a number of drivers and examples written for Adafruit's Feather ecosystem. Here are places to start: -* https://github.com/adafruit?utf8=%E2%9C%93&q=Adafruit_MicroPython&type=&language= +* [Adafruit repos with CircuitPython topic](https://github.com/search?q=topic%3Acircuitpython+org%3Aadafruit+fork%3Atrue) +* [Adafruit driver bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index efcc5fee8..1481caad7 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -132,7 +132,7 @@ When adding extra functionality to CircuitPython to mimic what a normal operating system would do, either copy an existing CPython API (for example file writing) or create a separate module to achieve what you want. For example, mounting and unmount drives is not a part of CPython so it should be done in a -module, such as a new ``filesystem``, that is only available in CircuitPython. +module, such as a new ``storage`` module, that is only available in CircuitPython. That way when someone moves the code to CPython they know what parts need to be adapted. @@ -235,12 +235,13 @@ Renders as: Use BusDevice -------------------------------------------------------------------------------- -BusDevice is an awesome foundational library that manages talking on a shared -I2C or SPI device for you. The devices manage locking which ensures that a -transfer is done as a single unit despite CircuitPython internals and, in the -future, other Python threads. For I2C, the device also manages the device -address. The SPI device, manages baudrate settings, chip select line and extra -post-transaction clock cycles. +[BusDevice](https://github.com/adafruit/Adafruit_CircuitPython_BusDevice) is an +awesome foundational library that manages talking on a shared I2C or SPI device +for you. The devices manage locking which ensures that a transfer is done as a +single unit despite CircuitPython internals and, in the future, other Python +threads. For I2C, the device also manages the device address. The SPI device, +manages baudrate settings, chip select line and extra post-transaction clock +cycles. I2C Example ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/drivers.rst b/docs/drivers.rst index ccd154a51..83f3ad035 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -38,7 +38,7 @@ the ``lib/`` directory. Some drivers may not work without them. Helper Libraries ------- -These libraries build on top of the low level APIS to simplify common tasks. +These libraries build on top of the low level APIs to simplify common tasks. .. toctree:: USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/> |