Skip to content

Examples currently in use by Mbed OS docs that are in need of a home

License

Notifications You must be signed in to change notification settings

adbridge/mbed-os-examples-docs_only

This branch is 3 commits ahead of, 3 commits behind ARMmbed/mbed-os-examples-docs_only:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3f71b9f · Feb 8, 2021
Jun 18, 2020
Aug 10, 2020
Mar 4, 2020
Mar 31, 2020
May 27, 2020
Dec 7, 2020
Feb 8, 2021
Mar 3, 2020
Mar 31, 2020
Dec 7, 2020
Mar 3, 2020
Mar 31, 2020
Mar 29, 2020
Mar 3, 2020
Mar 29, 2020
May 27, 2020
Oct 15, 2018
Nov 6, 2019
Oct 11, 2018
Feb 26, 2020
Jan 19, 2020
May 27, 2020

Repository files navigation

Mbed OS docs-only examples

This repository contains example applications snippets that only exist in the Mbed OS docs.

Contributions

Contributions to the example folder need to meet these requirements:

  • Every individual example snippet needs to contain a main.cpp that compiles. You must place this file into a folder with all other required files.
  • The path to the folder has to be in the second-level folder structure Repo_ROOT/<Level1>/<Level2>/main.cpp. We recommend you follow our conventions: Repo_ROOT/Category_Topic/Module_Example.
  • A README.md file in the snippet folder is optional. Contribute the main instructions and explanatory documents to the mbed-os-5-docs repository.
  • The Level2 folder name, for example <Module_Example>, needs to be unique compared to any other Level2 folder in this repository. It can contain no more than 34 characters.

The CI on this repository checks on the above criteria and also makes sure the snippets can build.

About

Examples currently in use by Mbed OS docs that are in need of a home

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 99.6%
  • Python 0.4%