Remove all README contents and just point to the docs. #217
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
|
Replaced by #218. |
ketch
pushed a commit
that referenced
this pull request
Nov 14, 2022
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 replaces everything in the README (except the badges at the top) with a link to the main docs at clawpack.org. The idea is that we shouldn't be trying to maintain docs in both places, and in the past we haven't maintained this README much which has led to confusion (see e.g. #203 (comment) where somebody got outdated installation instructions from this README).
I believe that everything that was in the README is superseded by what is currently in the docs.
We may want to do the same for other sub-repo README files.