Skip to content

Updates for README.md#1010

Merged
adpaco-aws merged 3 commits intomodel-checking:mainfrom
adpaco-aws:doc-review-readme
Apr 5, 2022
Merged

Updates for README.md#1010
adpaco-aws merged 3 commits intomodel-checking:mainfrom
adpaco-aws:doc-review-readme

Conversation

@adpaco-aws
Copy link
Contributor

@adpaco-aws adpaco-aws commented Apr 4, 2022

Description of changes:

Simplifies/standardizes the README.md file. The rationale:

  • In description: Replaces the old description to make it more concrete and clear. The new description is inspired by CBMC's description and adds "- even in unsafe Rust code". Rewording are welcome (I even considered converting into a bulleted list, let me know if you like this idea).
  • Simplifies the text for installation.
  • Removes "What does Kani do?" because that should be clear in the description. We can add a "Documentation" section later if you like but most people will have arrived to it already by then.
  • Comments on the code snippet may help readers to understand the example. A couple of rewording being made here too.
  • Replaces "Developer guide" with "Contributing", which is the standard.
  • In license: Replaced "the Rust compiler" with "Rust". This is important: We use code from the Rust project in general (e.g., rustdoc), not just the compiler.

Resolved issues:

Part of #700

Testing:

  • How is this change tested? N/A

  • Is this a refactor change? No.

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@adpaco-aws adpaco-aws requested a review from a team as a code owner April 4, 2022 20:35
Copy link
Contributor

@zhassan-aws zhassan-aws left a comment

Choose a reason for hiding this comment

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

A few minor comments.

@adpaco-aws adpaco-aws merged commit baa7847 into model-checking:main Apr 5, 2022
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 26, 2022
* Updates for `README.md`

* Address comments

* Use lowercase in bullet list
tedinski pushed a commit that referenced this pull request Apr 27, 2022
* Updates for `README.md`

* Address comments

* Use lowercase in bullet list
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants