search

PelionIoT / pelion-ready-example

Pelion Device Ready example - deprecated
https://github.com/ARMmbed/pelion-ready-example
Apache License 2.0
2 stars 18 forks source link

README too focused on partner porting, not customers' usage of the application #32

Closed maclobdell closed 4 years ago

maclobdell commented 6 years ago

The existing README is written with partners as the intended audience. However, if a partner forks the repo, they will want to have a very different readme that is written with potential customers as the audience. We should help them by providing a template readme that they can use.

I recommend the following.

  1. the partner porting information be moved to another file. Maybe a markdown file in a docs folder
  2. remove all references to specific targets. use instead
  3. Change the README content to highlight the features of the demo, how to import, use, and expand it.
  4. In the README provide a section for partners to highlight how they have customized the template demo (e.g. for NXPs version, they are actually using the button presses and not simulated button press. this is a modification to main.cpp that is done each time a new template version comes out).