Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify README, move content to documentation #100

Open
wants to merge 20 commits into
base: develop
Choose a base branch
from

Conversation

mdpiper
Copy link
Member

@mdpiper mdpiper commented Apr 10, 2024

This PR includes a pair of changes to the documentation:

  1. With recent changes to the babelizer API (e.g., Remove options for babelize generate command #91 and Replace cookiecutter #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 Add link to docs in the About section and README #98 and Fix installation with Conda #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
Copy link
Member

@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
Copy link
Member Author

mdpiper commented Apr 10, 2024

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

@aufdenkampe
Copy link

aufdenkampe commented Apr 10, 2024

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?

@mdpiper mdpiper changed the title Update repository files Simplify README, move content to documentation Apr 12, 2024
@mdpiper mdpiper marked this pull request as ready for review April 12, 2024 02:30
@mdpiper mdpiper requested a review from mcflugen April 12, 2024 02:30
@aufdenkampe aufdenkampe mentioned this pull request May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix installation with Conda Add link to docs in the About section and README
3 participants