adafruit-mirror/Adafruit_Learning_System_Guides
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Revamp Learn System README

Browse source 
The README was expanded to link to guide information on contributing, licensing, and Adafruit Playground.
This commit is contained in:
Anne Barela 2023-11-15 12:01:18 -05:00 committed by GitHub
parent 94a17bc20f
commit 65c0d0ff93
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -1,22 +1,28 @@
[![Build Status](https://travis-ci.com/adafruit/Adafruit_Learning_System_Guides.svg?branch=main)](https://travis-ci.com/adafruit/Adafruit_Learning_System_Guides)
# Introduction
This is a collection of smaller programs and scripts to display "inline" in
[Adafruit Learning System][learn] guides. Subdirectories here will generally
contain a README with a link to their corresponding guide.
This is a collection of smaller programs and scripts to display "inline" in [Adafruit Learning System][learn] guides.
## Testing
Adafruit is an Open Source company. To support Adafruit, please consider buying products at [adafruit.com](https://www.adafruit.com/).
The code here is partially checked by GitHub Actions against Pylint (for
CircuitPython code) or the Arduino compilation process.
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.
Code in directories containing a file called `.circuitpython.skip` will be
skipped by Pylint checks.
## Issues
Code in directories containing a `.[platformname].test` file, such as
`.uno.test` will be compiled against the corresponding platform.
Issues with guides should be reported in the guide itself under "Feedback? Corrections?"
This is a work in progress.
## 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!](https://learn.adafruit.com/adafruit-playground-notes).
## Contributing and Testing
For details on contributing for Adafruit approved guides, see the guide [Contribute to the Adafruit Learning System with Git and GitHub](https://learn.adafruit.com/contribute-to-the-adafruit-learning-system-with-git-and-github) and [Contribute to CircuitPython with Git and GitHub](https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github/github-personal-access-token).
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.
[learn]: https://learn.adafruit.com/
@ -32,3 +38,9 @@ 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](https://learn.adafruit.com/contribute-to-the-adafruit-learning-system-with-git-and-github/add-author-and-license-information) for more.
Updated November 15, 2023