Skip to content

Move example Wiki to the source tree #170

@kbumsik

Description

@kbumsik

I suggest moving the example Wiki (https://github.com/nnstreamer/nnstreamer/wiki/usage-examples-screenshots) to the source tree in this repo (maybe in README.md).

To be clear, I am talking about the specific wiki page, not the Wiki as a whole. I think the other pages are in the right place.

When I was having fun with the examples, I noticed the wiki page is out of sync with the repo. For example, s/nnsuite/nnstreamer/g, the use of wget when get_model.sh is available, some undocumented examples, and etc.

Although Github Wiki is a convenient tool to quickly update notes but Github Wiki has some drawbacks. I could not submit a change even though I noticed some errors, because the wiki currently allows edits only from contributors.

Moving the example Wiki to README.md will have advantages:

  1. Allows other developers to correct errors through a PR.
  2. It is easier to keep it updated. You can ask a PR to add descriptions of new examples in README.md during the review process. I believe it is quite important.

Thanks for reading :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    ContributhonOpenSource Contributhon 2020

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions