Examples README.md description - Githubissues

eclipse-archived / kiso

Kiso Project

Other

30 stars 31 forks source link

Examples README.md description #100

Open HansUweRempler opened 4 years ago

HansUweRempler commented 4 years ago

Add a README.md for every Kiso example. The readme shall include following sections:

[ ] Introduction: what is this example about?
[ ] Hardware: describing exactly what HW is supported and how it needs to be connected, configured, etc. (maybe with photo)
[ ] Quick start: how to build, flash and run

Examples list:

kiso/examples/CommonGateway/
- c-cellular
- c-leds
- c-sensors
kiso/examples/NucleoF767/
- c-leds
...

See the folllowing examples description from our Bosch colleagues as a reference: https://github.com/eclipse/iceoryx/tree/master/iceoryx_examples/icedelivery

HansUweRempler commented 4 years ago

Andreas B. to look into this (with Debasish as documentation owner)