Better README - Githubissues

NOAA-GFDL / NDSL

NOAA NASA Domain Specific Language middleware layer

6 stars 8 forks source link

Better README #27

Closed FlorianDeconinck closed 5 months ago

FlorianDeconinck commented 6 months ago

Poke @bensonr @oelbert @fmalatino

Let's do a pass on the README

bensonr commented 6 months ago

@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.)?

FlorianDeconinck commented 6 months ago

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 commented 6 months ago

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

FlorianDeconinck commented 6 months ago

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