You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository contains example applications snippets that currently only exist in the Mbed OS docs.
1
+
# Mbed OS docs-only examples
2
+
3
+
This repository contains example applications snippets that only exist in the Mbed OS docs.
3
4
4
5
## Contributions
5
6
6
-
Contribute the the example folder need to following bellow requirements
7
-
- Every individual example snippet need to contain a compile-able `main.cpp` and placed into one folder with all required files.
8
-
- The path to the folder has to be in the 2 level folder structure `Repo_ROOT/<Level1>/<Level2>/main.cpp` we recommend to following our conventions: `Repo_ROOT/Category_Topic/Module_Example`
9
-
- A `README.md` file in the snippet folder is optional, the main instruction and explanatory documents should be contributed to [mbed-os-docs](https://github.com/ARMmbed/mbed-os-5-docs).
10
-
- the `Level2` folder name, e.g. `<Module_Example>`, need to be unique to any other `Level2` folder in this repository and contains no more than 34 characters.
11
-
- The CI on this repository will check on the above criteria and also make sure the snippets able to be built
7
+
Contributions to the example folder need to meet these requirements:
8
+
9
+
- 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.
10
+
- 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`.
11
+
- 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.
12
+
- 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.
13
+
14
+
The CI on this repository checks on the above criteria and also makes sure the snippets can build.
0 commit comments