-
Notifications
You must be signed in to change notification settings - Fork 3
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
mdpiper
wants to merge
20
commits into
develop
Choose a base branch
from
mdpiper/update-repo-files
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@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. |
@mcflugen Sounds good! I'll do this next. |
Keep a stub section in the README pointing to the docs.
mdpiper
changed the title
Update repository files
Simplify README, move content to documentation
Apr 12, 2024
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes a pair of changes to the documentation:
README.rst
was out of date.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.