search

open-horizon-services / service-yolo-cpu

Apache License 2.0
0 stars 3 forks source link

Add README #2

Open t-fine opened 2 years ago

t-fine commented 2 years ago

This README needs better information:

  1. Front matter
  2. Shields - license should match LICENSE file
  3. Description
  4. Prerequisites
  5. Installation
  6. Usage
  7. Advanced Details
  8. Authors - should match MAINTAINERS.md

See examples of good README.md files:

oluwafemiomoyeni commented 1 year ago

@joewxboy Can you assign this issue to me? I am interested in it. Thanks.

t-fine commented 1 year ago

@oluwafemiomoyeni I can help you with that 👍🏻

oluwafemiomoyeni commented 1 year ago

Thanks @t-fine. Is there a document that points at what should be part of the readme?

joewxboy commented 1 year ago

@oluwafemiomoyeni See this file: https://github.com/open-horizon-services/web-helloworld-python/blob/main/README.md and this one: https://github.com/open-horizon-services/service-node-red-object-detection/blob/main/README.md For an example of good README files. Let us know if you have any questions.

oluwafemiomoyeni commented 1 year ago

Thanks @joewxboy