Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jaisnan committed Sep 26, 2023
1 parent fab837c commit f3955ff
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,12 @@ If omitted, the latest version of `Kani` hosted on [`Kani's crates.io page`](htt

## Example usage in a workflow YAML file:

Here are a few examples of workflow YAML files for the Kani Github Action
Here are a few examples of workflow YAML files for the Kani Github Action:

#### Example 1: Default configuration

Default config which uses the latest version of Kani to run `cargo-kani` on project in current directory.

#### Example 1: Default config which uses the latest version of kani to run `cargo-kani` on project in current directory
```yaml
jobs:
kani:
Expand All @@ -53,7 +56,10 @@ jobs:
uses: model-checking/[email protected]
```
#### Example 2: Use a specific version of kani, version `0.35.0`, to run `cargo-kani` on a project
#### Example 2: Use pinned version of Kani
Use a specific version of Kani, version `0.35.0`, to run `cargo-kani` on a project.

```yaml
jobs:
kani:
Expand All @@ -67,7 +73,10 @@ jobs:
working-directory: './path/to/project'
```

#### Example 3: Use pinned version of kani, version `0.35.0`, to run `cargo-kani --tests` on a project with propproof harnesses.
#### Example 3: Run Kani with args

Use latest version of Kani, to run `cargo-kani --tests` on a project with `propproof` harnesses.

```yaml
jobs:
kani:
Expand All @@ -76,9 +85,6 @@ jobs:
- name: Run Kani
uses: model-checking/[email protected]
with:
kani-version: '0.35.0'
command: 'cargo-kani'
working-directory: './path/to/project'
args: '--tests'
enable-propproof: true
```
Expand Down

0 comments on commit f3955ff

Please sign in to comment.