search

open-horizon-services / service-restcam

Open Horizon service container that provides a basic REST camera service
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:

joewxboy commented 2 years ago

See https://github.com/open-horizon-services/service-node-red-object-detection/blob/main/README.md for the sections to include. You can skip the author section. View the Makefile to determine which targets exist. Let me know if you have any questions or run into issues. This is a moderately difficult task.

julianchen215 commented 2 years ago

@joewxboy @t-fine may you please assign this issue to me?

mahi-pas commented 2 years ago

Hi, can you assign me to this issue? @joewxboy @t-fine

joewxboy commented 2 years ago

Hi @julianchen215 , I gave some details about this to @mahi-pas earlier so I hope you don't mind that I'm assigning to her. Feel free to collaborate with her if you wish.

joewxboy commented 2 years ago

@mahi-pas How is it going? Any blockers?