adafruit / Adafruit_Learning_System_Guides

Programs and scripts to display "inline" in Adafruit Learning System guides

Introduction

This is a collection of smaller programs and scripts to display "inline" in Adafruit Learning System guides.

Adafruit is an Open Source company. To support Adafruit, please consider buying products at adafruit.com.

Starting in 2023, guides using a specific Adafruit board will be placed in a subdirectory with that product name to reduce the number of directories under the main directory. If you are creating a new guide, please check if your Adafruit board falls into one of these groups and make your project code directory in the appropriate subfolder.

• Flora/
• ItsyBitsy/
• MagTag/
• MEMENTO/
• NeoTrellis/
• PyLeap/
• PyPortal/
• QTPy/

If a new product or project group is contemplated, contact Learn moderators for guidance.

Issues

Issues with guides should be reported in the guide itself under "Feedback? Corrections?"

Make Your Own Guides

This repo is only for Adafruit approved Learning System Guides. If you'd like to write your own guide, see Create your own content with Adafruit Playground!.

Contributing and Testing

For details on contributing for Adafruit approved guides, see the guide Contribute to the Adafruit Learning System with Git and GitHub and Contribute to CircuitPython with Git and GitHub.

The code here is checked by GitHub Actions against Pylint (for CircuitPython code) or the Arduino compilation process.

Code in directories containing a file called .circuitpython.skip will be skipped by Pylint checks.

Code in directories containing a .[platformname].test file, such as .uno.test will be compiled against the corresponding platform.

Running pylint locally

Install a specific version of pylint under the name "pylint-learn":

pip install pipx
pipx install --suffix=-learn pylint==2.7.1

Then use the pylint_check script to run pylint on the files or directories of your choice (note that your terminal must be in the top directory of Adafruit_Learning_System_Guides, not a sub-directory):

./pylint_check CircuitPython_Cool_Project

Licensing

Adafruit Learning System code files should have author and license information conforming to the open SPDX specification. See this page for more.

Updated November 29, 2023