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

Documentation: Updates for Installation #972

Merged
merged 3 commits into from
Mar 22, 2022

Conversation

adpaco-aws
Copy link
Contributor

Description of changes:

Updates the installation section:

  • Mention supported versions.
  • Add a box for dependencies installation note.
  • Be more specific about the message to be seen when test is fixed.
  • Other minor changes.

Resolved issues:

Part of #700

Call-outs:

Testing:

  • How is this change tested? Existing regression.

  • 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 March 22, 2022 14:57
Comment on lines +11 to +13
> **Note:** These dependencies may be installed by running the CI scripts shown
> below and there is no need to install them separately, for their respective
> OS.
Copy link
Contributor

Choose a reason for hiding this comment

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

We moved this up originally because people would start installing things without having read it yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, moving it back for this reason.

@celinval celinval merged commit ed62372 into model-checking:main Mar 22, 2022
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 22, 2022
* Documentation: Updates for Installation

* Add `kani::proof` tag to test

* Move note up
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 25, 2022
* Documentation: Updates for Installation

* Add `kani::proof` tag to test

* Move note up
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 26, 2022
* Documentation: Updates for Installation

* Add `kani::proof` tag to test

* Move note up
tedinski pushed a commit that referenced this pull request Apr 27, 2022
* Documentation: Updates for Installation

* Add `kani::proof` tag to test

* Move note up
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.

3 participants