From 7a222f6e4f7ec85da4e41f5f0e5a07cb27e4dbe6 Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Thu, 19 Aug 2021 11:42:11 -0400 Subject: [PATCH] update libraries page and header links --- _includes/header.html | 10 ++--- _includes/header_mobile.html | 5 +-- libraries/index.html | 85 +++++++++++++++++++++++++----------- 3 files changed, 65 insertions(+), 35 deletions(-) diff --git a/_includes/header.html b/_includes/header.html index 85a669c9..88c9ad5d 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -8,12 +8,10 @@ News Awesome Newsletter - API - Help - - - - + Documentation + Forums + Discord + RSS diff --git a/_includes/header_mobile.html b/_includes/header_mobile.html index 9318064f..ee71d7ad 100644 --- a/_includes/header_mobile.html +++ b/_includes/header_mobile.html @@ -35,11 +35,10 @@ href="{{ "/awesome" | relative_url }}">Awesome
  • Newsletter
  • Get Started
    • -
  • Help
    • -
  • Discord
    • +
  • Forums
    • +
  • Discord
    • - diff --git a/libraries/index.html b/libraries/index.html index ae4709aa..2c804351 100644 --- a/libraries/index.html +++ b/libraries/index.html @@ -11,62 +11,87 @@ permalink: /libraries CircuitPython. They are designed for use with CircuitPython and may or may not work with MicroPython. The bundle options are explained below.

    - CircuitPython libraries are separate files designed to work with CircuitPython code. - CircuitPython programs require a lot of information to run. CircuitPython is so simple - to use because most of this information is processed in the background and stored in - libraries. Some libraries are built into CircuitPython. Others are downloaded and - stored on your CIRCUITPY drive in a folder called lib. + CircuitPython libraries are written in Python. They provide additional functionality + and support external devices, beyond what is in CircuitPython itself. + Libraries are stored on your CIRCUITPY drive in a folder called lib. + For more information on using and managing libraries, see the + Welcome To CircuitPython Guide.

    -

    - The full list of all the CircuitPython libraries contained in the following bundles - can be found on the - libraries page.

    +

    Documentation

    +

    + The + libraries documentation page + contains a categorized list of all the CircuitPython libraries included in the following bundles, + with links to the documentation for every library.

    Download and Installation Instructions

    - The libraries in each release are compiled to .mpy for all recent major versions - of CircuitPython. Please download the bundle that matches the major version - of your CircuitPython. For example, if you are running 6.0.0 you should - download the 6.x bundle. The .mpy files are designed to take up less space on - your CIRCUITPY drive. Unless you have a specific reason, choose the appropiate - .mpy library bundle! + You can download all the available libraries in a zip-file bundle for all recent major + versions of CircuitPython. These bundles are updated daily, whenever any included library is updated. +

    +

    + The libraries in each release are supplied as .mpy files, which are compiled + versions of Python source code. + Make sure to download the bundle that matches the major version + of your CircuitPython, because the .mpy files can change between versions. + For example, if you are running 6.3.0 you should download the 6.x bundle. +

    +

    + The precompiled .mpy files take up less space on your CIRCUITPY drive than the .py files. + They also load faster, and for some low-RAM boards, are required because the .py files + are too large to compile on the board itself. + Unless you need the source version, choose the appropiate .mpy library bundle! + If you need to compile .py files to .mpy, you can + run the mpy-cross + cross-compiler yourself.

    To install, download the appropriate bundle for your version of CircuitPython. - Unzip the file, open the resulting folder and find the lib folder. Open the lib - folder and find the library files you need to load. Create a lib folder on your - CIRCUITPY drive. Copy the individual library files you need to the lib folder - on your CIRCUITPY drive. + Unzip the file, open the resulting folder and find the lib folder. Open the lib + folder and find the library files you need to load. Create a lib folder on your + CIRCUITPY drive. Copy the individual library files you need to the lib folder + on your CIRCUITPY drive. More details are available + here.

    You can always find the latest releases of the libraries bundle on GitHub. +

    +

    + An alternative way to download and update libraries on your board is to use the + CircUp tool, + which is under development. +

    +
    +
    +

    Bundles

    -

    Bundle Version 6.x

    +

    Bundle for Version 6.x

    This bundle is built for use with CircuitPython 6.x.x. If you are using CircuitPython 6, please download this bundle.

    -

    Bundle Version 7.x

    +

    Bundle for Version 7.x

    This bundle is built for use with CircuitPython 7.x.x. If you are using - CircuitPython 7, please download this bundle. + CircuitPython 7, please download this bundle. The .mpy format has + changed for CircuitPython 7; 6.x .mpy files are not compatible.

    -

    Bundle Version py

    +

    Python Source Bundle

    - This bundle is the uncompiled source code for every library. It is not + This bundle is the uncompiled Python source code for every library. It is not intended for general use! It is only recommended if you need to edit - a library file. This bundle works with all versions of CircuitPython. + a library file. This bundle works with all supported versions of CircuitPython.

    -

    Bundle Examples

    +

    Examples Bundle

    Every CircuitPython library has examples to go along with it. This bundle contains every library example. This bundle will have examples that @@ -76,6 +101,14 @@ permalink: /libraries

    +
    +

    The Community Bundle

    +

    + The libraries in the bundles above are officially supported. + Additional libraries written and supported by community members are available in the + Community Bundle. +

    +

    Contributing