https://github.com/armmbed/mbed-os-examples-docs_only
Examples currently in use by Mbed OS docs that are in need of a home
https://github.com/armmbed/mbed-os-examples-docs_only
Last synced: about 1 year ago
JSON representation
Examples currently in use by Mbed OS docs that are in need of a home
- Host: GitHub
- URL: https://github.com/armmbed/mbed-os-examples-docs_only
- Owner: ARMmbed
- License: apache-2.0
- Created: 2018-10-11T14:19:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T15:51:49.000Z (over 3 years ago)
- Last Synced: 2023-08-03T07:54:21.648Z (almost 3 years ago)
- Language: C++
- Size: 13.6 MB
- Stars: 5
- Watchers: 80
- Forks: 25
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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///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](https://github.com/ARMmbed/mbed-os-5-docs) repository.
- The `Level2` folder name, for 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.