Skip to content

Commit f5bf928

Browse files
kattnikattni
authored
Merge pull request #741 from dhalbert/lib-documentation-improvements
update libraries page and header links
2 parents 435381a + 7a222f6 commit f5bf928

File tree

3 files changed

+65
-35
lines changed

3 files changed

+65
-35
lines changed

‎_includes/header.html

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@
88
<a href="https://blog.adafruit.com/category/circuitpython">News</a>
99
<a {% if current[1] == 'awesome' %}class='active'{% endif %} href="{{ "/awesome" | relative_url }}">Awesome</a>
1010
<a href="https://www.adafruitdaily.com/category/circuitpython">Newsletter</a>
11-
<a href="https://circuitpython.readthedocs.io/">API</a>
12-
<a href="https://forums.adafruit.com/viewforum.php?f=60">Help</a>
13-
<span>
14-
<a href="https://adafru.it/discord" aria-label="Discord"><i class="fab fa-discord"></i></a>
15-
<a href="{{ '/feed.rss' | relative_url }}" type="application/rss+xml" aria-label="RSS Feed"><i class="fas fa-rss-square"></i></a>
16-
</span>
11+
<a href="https://circuitpython.readthedocs.io/">Documentation</a>
12+
<a href="https://forums.adafruit.com/viewforum.php?f=60">Forums</a>
13+
<a href="https://adafru.it/discord" aria-label="Discord"><i class="fab fa-discord"></i> Discord</a>
14+
<a href="{{ '/feed.rss' | relative_url }}" type="application/rss+xml" aria-label="RSS Feed"><i class="fas fa-rss-square"></i> RSS</a>
1715
</div>
1816
</div>
1917
</nav>

‎_includes/header_mobile.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@
3535
href="{{ "/awesome" | relative_url }}">Awesome</a></li>
3636
<li><a href="https://www.adafruitdaily.com/category/circuitpython">Newsletter</a></li>
3737
<li><a href="https://learn.adafruit.com/welcome-to-circuitpython">Get Started</a></li>
38-
<li><a href="https://forums.adafruit.com/viewforum.php?f=60">Help</a></li>
39-
<li><a href="https://adafru.it/discord">Discord</a></li>
38+
<li><a href="https://forums.adafruit.com/viewforum.php?f=60">Forums</a></li>
39+
<li><a href="https://adafru.it/discord" aria-label="Discord"><i class="fab fa-discord"></i> Discord</a></li>
4040
</ul>
4141
</nav>
4242
</div>
4343
<div class="bottom-bar"></div>
4444
</header>
45-

‎libraries/index.html

Lines changed: 59 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,62 +11,87 @@ <h1>CircuitPython Libraries</h1>
1111
CircuitPython. They are designed for use with CircuitPython and may or may not
1212
work with MicroPython. The bundle options are explained below.
1313
<p>
14-
CircuitPython libraries are separate files designed to work with CircuitPython code.
15-
CircuitPython programs require a lot of information to run. CircuitPython is so simple
16-
to use because most of this information is processed in the background and stored in
17-
libraries. Some libraries are built into CircuitPython. Others are downloaded and
18-
stored on your CIRCUITPY drive in a folder called lib.
14+
CircuitPython libraries are written in Python. They provide additional functionality
15+
and support external devices, beyond what is in CircuitPython itself.
16+
Libraries are stored on your <b>CIRCUITPY</b> drive in a folder called <b>lib</b>.
17+
For more information on using and managing libraries, see the
18+
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">Welcome To CircuitPython Guide</a>.
1919
</p>
20-
<p>
21-
The full list of all the CircuitPython libraries contained in the following bundles
22-
can be found on the
23-
<a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html" title="">libraries page</a>.
2420
<section>
21+
<h2>Documentation</h2>
22+
<p>
23+
The
24+
<a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html" title="">libraries documentation page</a>
25+
contains a categorized list of all the CircuitPython libraries included in the following bundles,
26+
with links to the documentation for every library.
2527
<h2>Download and Installation Instructions</h2>
2628
<p>
27-
The libraries in each release are compiled to .mpy for all recent major versions
28-
of CircuitPython. Please download the bundle that matches the major version
29-
of your CircuitPython. For example, if you are running 6.0.0 you should
30-
download the 6.x bundle. The .mpy files are designed to take up less space on
31-
your CIRCUITPY drive. Unless you have a specific reason, choose the appropiate
32-
.mpy library bundle!
29+
You can download all the available libraries in a zip-file bundle for all recent major
30+
versions of CircuitPython. These bundles are updated daily, whenever any included library is updated.
31+
</p>
32+
<p>
33+
The libraries in each release are supplied as <b>.mpy</b> files, which are compiled
34+
versions of Python source code.
35+
<strong>Make sure to download the bundle that matches the major version
36+
of your CircuitPython</strong>, because the <b>.mpy</b> files can change between versions.
37+
For example, if you are running 6.3.0 you should download the 6.x bundle.
38+
</p>
39+
<p>
40+
The precompiled <b>.mpy</b> files take up less space on your CIRCUITPY drive than the <b>.py</b> files.
41+
They also load faster, and for some low-RAM boards, are required because the <b>.py</b> files
42+
are too large to compile on the board itself.
43+
<strong>Unless you need the source version, choose the appropiate <b>.mpy</b> library bundle!</strong>
44+
If you need to compile <b>.py</b> files to <b>.mpy</b>, you can
45+
<a href="https://learn.adafruit.com/welcome-to-circuitpython/frequently-asked-questions#how-can-i-create-my-own-mpy-files-3020687-11">run the <b>mpy-cross</b>
46+
cross-compiler yourself</a>.
3347
</p>
3448
<p>
3549
<b>To install</b>, download the appropriate bundle for your version of CircuitPython.
36-
Unzip the file, open the resulting folder and find the lib folder. Open the lib
37-
folder and find the library files you need to load. Create a lib folder on your
38-
CIRCUITPY drive. Copy the individual library files you need to the lib folder
39-
on your CIRCUITPY drive.
50+
Unzip the file, open the resulting folder and find the <b>lib</b> folder. Open the lib
51+
folder and find the library files you need to load. Create a <b>lib</b> folder on your
52+
CIRCUITPY drive. Copy the individual library files you need to the <b>lib</b> folder
53+
on your CIRCUITPY drive. More details are available
54+
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">here</a>.
4055
</p>
4156
<p>
4257
You can always find the
4358
<a href="https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest">latest releases of the libraries bundle</a>
4459
on GitHub.
60+
</p>
61+
<p>
62+
An alternative way to download and update libraries on your board is to use the
63+
<a href="https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup">CircUp tool</a>,
64+
which is under development.
65+
</p>
66+
</section>
67+
<section>
68+
<h2>Bundles</h2>
4569
<div class="release-section">
4670
<div id="adafruit-circuitpython-bundle-6.x-mpy">
47-
<h3>Bundle Version 6.x</h3>
71+
<h3>Bundle for Version 6.x</h3>
4872
<p>
4973
This bundle is built for use with CircuitPython 6.x.x. If you are using
5074
CircuitPython 6, please download this bundle.
5175
</p>
5276
</div>
5377
<div id="adafruit-circuitpython-bundle-7.x-mpy">
54-
<h3>Bundle Version 7.x</h3>
78+
<h3>Bundle for Version 7.x</h3>
5579
<p>
5680
This bundle is built for use with CircuitPython 7.x.x. If you are using
57-
CircuitPython 7, please download this bundle.
81+
CircuitPython 7, please download this bundle. The .mpy format has
82+
changed for CircuitPython 7; 6.x .mpy files are not compatible.
5883
</p>
5984
</div>
6085
<div id="adafruit-circuitpython-bundle-py">
61-
<h3>Bundle Version py</h3>
86+
<h3>Python Source Bundle</h3>
6287
<p>
63-
This bundle is the uncompiled source code for every library. It is not
88+
This bundle is the uncompiled Python source code for every library. It is not
6489
intended for general use! It is only recommended if you need to edit
65-
a library file. This bundle works with all versions of CircuitPython.
90+
a library file. This bundle works with all supported versions of CircuitPython.
6691
</p>
6792
</div>
6893
<div id="adafruit-circuitpython-bundle-examples">
69-
<h3>Bundle Examples</h3>
94+
<h3>Examples Bundle</h3>
7095
<p>
7196
Every CircuitPython library has examples to go along with it. This bundle
7297
contains every library example. This bundle will have examples that
@@ -76,6 +101,14 @@ <h3>Bundle Examples</h3>
76101
</div>
77102
</div>
78103
</section>
104+
<section>
105+
<h2>The Community Bundle</h2>
106+
<p>
107+
The libraries in the bundles above are officially supported.
108+
Additional libraries written and supported by community members are available in the
109+
<a href="https://github.com/circuitpython/CircuitPython_Org_Bundle">Community Bundle</a>.
110+
</p>
111+
</section>
79112
<section>
80113
<h2>Contributing</h2>
81114
<p>

0 commit comments

Comments
 (0)