search

csdms / babelizer

Transform BMI-wrapped models into Python packages
https://babelizer.readthedocs.io
MIT License
4 stars 3 forks source link

Simplify README, move content to documentation #100

Open mdpiper opened 7 months ago

mdpiper commented 7 months ago

This PR includes a pair of changes to the documentation:

  1. With recent changes to the babelizer API (e.g., #91 and #96), information in README.rst was out of date.
  2. Including the contents of README.rst in the docs made them harder to navigate (see #98 and #99).

To address these changes, I updated the content in README.rst, but then moved most of that content to the docs, leaving a much simpler README with links to the documentation.

This fixes #98 and fixes #99.

mcflugen commented 7 months ago

@mdpiper How about significantly paring back the readme file and moving most everything to readthedocs? I've done something like that in bmi-wavewatch3 and I think it works pretty well.

mdpiper commented 7 months ago

@mcflugen Sounds good! I'll do this next.

aufdenkampe commented 7 months ago

Thanks for doing this! When I ran through the C Example (as described in #102), I was surprised that there was no mention of the move to using meson build system (#87, #90). It seems like it all happens under the hood. Regardless, is there any value in mentioning meson in these docs?