Better README

[FlorianDeconinck]

No description provided.

[FlorianDeconinck]

Poke @bensonr @oelbert @fmalatino

Let's do a pass on the README

[bensonr]

@FlorianDeconinck - Thanks for cleaning up the language. How much more do we want in a README vs. other documents (contribution guidelines, supported/tested libraries and packages, etc.)?

[oelbert]

minor cleanup

[FlorianDeconinck]

Good question. Here's a list on the top of my head to start the discussion:

• Link to code/contribution guideline
• Point of Contact for researchers/institutions to reach out
• Matrix of compiler/python supported
• Models supported (?)

Anything else?

[bensonr]

I think the only missing thing is a github.io-like site generated by an auto-documenter listing the public functions and APIs.

[FlorianDeconinck]

I think the only missing thing is a github.io-like site generated by an auto-documenter listing the public functions and APIs.

Yep. good one. I'll write/stub all those things and we can complete

[bensonr]

Thanks @FlorianDeconinck, this is coming along nicely

[oelbert]

Thanks Florian!