catie-aq/cookiecutter_mbed-os-app

Remove mbed documentation from template readme

Opened this issue · 2 comments

Mbed OS usage should not be described in template.

We may link to official documentation instead.

Could a simple warning be sufficient, and keep Mbed CLI 1 commands in the readme for a kick setup ?
See commit 1b32e6a

I was pointing the fact that the usage section should describe how to use the application and not how to build it.

We could remove the build section and point to a general Mbed OS building guide and fill the usage section with the needed information.

Or add a "Build" section?