search

TEOS-10 / GSW-Python

Python implementation of TEOS-10 GSW based on ufunc wrappers of GSW-C
https://teos-10.github.io/GSW-Python
Other
143 stars 30 forks source link

Add a "Development Instructions" README/Docs #129

Closed ocefpaf closed 5 months ago

ocefpaf commented 1 year ago

Currently we only have this note in our README:

It is neither necessary nor recommended to run the code generators, and no instructions are provided for them;
their output is included in the repo.

While I agree that the average user should not do that, we need to document those steps if we wish to lower the barrier for new developers.

It should be as simple as "promoting" the tools/README.txt to a first class citizen in our docs and/or linking it in our README.md.

efiring commented 1 year ago

Agreed.