Skip to content

Update README on GitHub#3277

Merged
terhorstd merged 7 commits intonest:masterfrom
jessica-mitchell:update-readme
Dec 9, 2024
Merged

Update README on GitHub#3277
terhorstd merged 7 commits intonest:masterfrom
jessica-mitchell:update-readme

Conversation

@jessica-mitchell
Copy link
Contributor

@jessica-mitchell jessica-mitchell commented Aug 6, 2024

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

@jessica-mitchell jessica-mitchell added T: Enhancement New functionality, model or documentation S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Aug 6, 2024
Copy link
Contributor

@terhorstd terhorstd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some smaller changes that could be considered. Not a strong requirement though. If there are reasons against this, of course feel free to reject them, or improve the language constructs where necessary.

jessica-mitchell and others added 3 commits August 27, 2024 09:24
Co-authored-by: Dennis Terhorst <terhorstd@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Nov 4, 2024

Pull request automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Nov 4, 2024
Copy link
Contributor

@terhorstd terhorstd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the work and the enduring push on this.
The text looks much better!

@terhorstd terhorstd merged commit 708afd9 into nest:master Dec 9, 2024
@jessica-mitchell jessica-mitchell added T: Maintenance Work to keep up the quality of the code and documentation. and removed T: Enhancement New functionality, model or documentation labels Sep 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Maintenance Work to keep up the quality of the code and documentation.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Update README

2 participants

Comments