[DOC] README suggestions

[phinate]

Hi team! I'm going through the project for the first time, and I found it a bit hard to work out what scivision is for without clicking on a bunch of links to go between the repo, api docs, examples repo, and sci.vision.

In particular, the README contains only links to other docs, and no summary about the project. As a developer browsing a repo, I would expect to be able to instantly see how to install the python package, and a brief example of usage. (Until I saw the example jupyter notebooks, I assumed this was a matplotlib wrapper or some other visualization package!)

Here are a couple of small suggestions I think could really benefit the README:

about

• A one-paragraph summary of what the package is for, and an example context I can use it.

installation

• You hide the python installation in the docs; I would assume it to be a one-liner in pip that could just live here. The python version install matrix would automatically be handled by pip depending on which version of python is being used.

usage

• A quick example snippet to show how to do something useful, e.g. a few lines from the object detection notebook.

This also applies to the web app -- when you load it, you're met with a list of pictures representing models/datasets, but I have no idea what they mean (are they models you've trained? models you can use? how do I use them? why do i want to use them?) etc.

If you want a PR for this, I'll happily give it a go, but I think you're better positioned as maintainers to answer these questions compared to me who just found out what the project is :p

Hope this is useful!

[ots22]

Thanks @phinate, and sorry for the (very) slow response.

#610 (just merged) updates the README to add an overview of the project and an example, which I think addresses some of your points? We intentionally had the README directing people straight to the website and docs to avoid a third place to keep up to date but probably went a bit too far.

Thanks for the feedback on the website too, will include with some of our notes (#543) and will probably get some attention reasonably soon.