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

readme: Update for 2.1 #3185

Merged
merged 2 commits into from
Sep 2, 2022
Merged

readme: Update for 2.1 #3185

merged 2 commits into from
Sep 2, 2022

Conversation

bradjc
Copy link
Contributor

@bradjc bradjc commented Aug 30, 2022

Pull Request Overview

For 2.1 we should update the main readme, as 2.0 is no longer brand new.

I'm not sure what we should put. I just removed most of what we had there, hoping that by now we don't need the disclaimers. Please add commits as you see fit.

Testing Strategy

n/a

TODO or Help Wanted

What text should we have about 2.x?

Documentation Updated

  • Updated the relevant files in /docs, or no updates are required.

Formatting

  • Ran make prepush.

@bradjc bradjc added rfc Issue designed for discussion and to solicit feedback. release-blocker Issue or PR that must be resolved before the next release labels Aug 30, 2022
Comment on lines -38 to -40
Initially, only [libtock-c](https://github.com/tock/libtock-c) is compatible
with Tock 2.0. Work on supporting Tock 2.0 for libtock-rs is [under
development](https://github.com/tock/libtock-rs/issues/322).
Copy link
Contributor

Choose a reason for hiding this comment

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

Seeing as tock/libtock-rs#322 is still open, we should probably keep this note.

Copy link
Contributor

Choose a reason for hiding this comment

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

libtock-rs works on Tock 2.1, it's just incomplete. In particular, it is missing test infrastructure and documentation. That sentence was true for 2.0 because the Tock 2.0 libtock-rs wasn't usable at the time of the Tock 2.0 release.

Copy link
Contributor

Choose a reason for hiding this comment

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

Never mind then! As long as the basics work at least, we definitely shouldn't steer people away from it.

@ppannuto
Copy link
Member

I think the way this is written, the bullet points of what makes Tock2 different from Tock1 still hold. Maybe could put back something like, For a summary of the latest new features and improvements [in recent point releases?], check out the [Changelog].

@bradjc
Copy link
Contributor Author

bradjc commented Aug 30, 2022

Please add commits!

@bradjc bradjc added the last-call Final review period for a pull request. label Sep 2, 2022
Copy link
Contributor

@hudson-ayers hudson-ayers left a comment

Choose a reason for hiding this comment

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

bors r+

@bors
Copy link
Contributor

bors bot commented Sep 2, 2022

@bors bors bot merged commit 3c2537a into master Sep 2, 2022
@bors bors bot deleted the readme-2.x-update branch September 2, 2022 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
last-call Final review period for a pull request. release-blocker Issue or PR that must be resolved before the next release rfc Issue designed for discussion and to solicit feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants