Update README on GitHub #3277
Open
Update README on GitHub #3277
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
jessica-mitchell
added
T: Enhancement
terhorstd
requested changes
Aug 26, 2024
Co-authored-by: Dennis Terhorst <terhorstd@users.noreply.github.com>
This was referenced Sep 25, 2024
|
Pull request automatically marked stale! |
github-actions
bot
added
the
stale
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 updates the README since much of the information is redundant and we can point to documentation for more details. Some parts like citation and contribution are also available in the docs but it seems appropriate to keep some of this info here.
Fixes #2939
You can see how this looks here: https://github.com/jessica-mitchell/nest-simulator/tree/update-readme?tab=readme-ov-file