Skip to content

Commit 6f34305

Browse files
authored
Merge pull request #85 from kattni/update-readme
Update readme.
2 parents 9b140e4 + c6783ee commit 6f34305

File tree

2 files changed

+29
-10
lines changed

2 files changed

+29
-10
lines changed

README.rst

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,30 +14,49 @@ Introduction
1414
:target: https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/actions/
1515
:alt: Build Status
1616

17-
This high level library provides objects that represent CircuitPlayground hardware.
17+
This high level library provides objects that represent Circuit Playground Express and Bluefruit hardware.
1818

1919
.. image :: ../docs/_static/circuitplayground_express.jpg
2020
:target: https://adafruit.com/product/3333
21-
:alt: CircuitPlayground Express
21+
:alt: Circuit Playground Express
22+
23+
.. image :: ../docs/_static/circuit_playground_bluefruit.jpg
24+
:target: https://adafruit.com/product/4333
25+
:alt: Circuit Playground Bluefruit
2226
2327
Installation
2428
=============
25-
This driver depends on many other libraries! Please install it by downloading
26-
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
29+
For Circuit Playground Express, simply install CircuitPython to use this library - the library itself and
30+
all of its dependencies are built into CircuitPython for Circuit Playground Express.
31+
32+
For Circuit Playground Bluefruit, you must install this library and all of its dependencies. Please download
33+
`the latest Adafruit CircuitPython library bundle <https://circuitpython.org/libraries>`_. Open the resulting
34+
zip file, open the lib folder within, and copy the following folders and files to the lib folder on your
35+
CIRCUITPY drive:
36+
37+
* adafruit_bus_device/
38+
* adafruit_circuitplayground/
39+
* adafruit_lis3dh.mpy
40+
* adafruit_thermistor.mpy
41+
* neopixel.mpy
42+
2743

2844
Usage Example
2945
=============
30-
Using it is super simple. Simply import the `cpx` variable from the module
31-
and then use it.
46+
Using this library is super simple. Simply import the ``cp`` variable from the module and then use it.
3247

3348
.. code-block :: python
3449
35-
from adafruit_circuitplayground.express import cpx
50+
from adafruit_circuitplayground import cp
3651
3752
while True:
38-
if cpx.button_a:
39-
print("Temperature:", cpx.temperature)
40-
cpx.red_led = cpx.button_b
53+
if cp.button_a:
54+
print("Temperature:", cp.temperature)
55+
cp.red_led = cp.button_b
56+
57+
To learn more about all the features of this library, check out the
58+
`CircuitPython Made Easy on Circuit Playground Express and Bluefruit guide <https://learn.adafruit.com/circuitpython-made-easy-on-circuit-playground-express>`_
59+
on the Adafruit Learn System.
4160

4261
Contributing
4362
============
18 MB
Loading

0 commit comments

Comments
 (0)