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

Proof readme files are out of date #81

Open
markrtuttle opened this issue Nov 18, 2021 · 3 comments
Open

Proof readme files are out of date #81

markrtuttle opened this issue Nov 18, 2021 · 3 comments
Labels
bug Something isn't working

Comments

@markrtuttle
Copy link
Contributor

The proof readme files copied into cbmc/proofs and cbmc/proofs/PROOFDIR are giving old instructions for how to install cbmc and run the proofs.

@archigup
Copy link

archigup commented Nov 18, 2021

Would be good to have the installation instructions there or in the repo readme.

As a developer running the instructions in the readme (https://github.com/awslabs/aws-templates-for-cbmc-proofs/blob/master/README.md), I get to the end of the "Starting a new proof" section and make fails as I don't have cbmc installed. I then look at the readme in the proof directory which just instructs to add cbmc to your path (See https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk/blob/main/test/cbmc/proofs/Defender_MatchTopic/README.md).

Edit: I see there is a short blurb at the top of the repo readme but its easy to skip over it as its at the end of the intro section; a seperate section for it would make it clearer.

@markrtuttle
Copy link
Contributor Author

Let us update all of the README files to point to the new training material.

@feliperodri
Copy link
Contributor

Related to #25

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants