Skip to content

Commit bf661d8

Browse files
jbertholdrv-auditordkcumming
authored
Replace out-dated initial disclaimer paragraph in README (#522)
Co-authored-by: devops <[email protected]> Co-authored-by: dkcumming <[email protected]>
1 parent c221c81 commit bf661d8

File tree

4 files changed

+12
-10
lines changed

4 files changed

+12
-10
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# MIR Semantics
22

3-
In this repository, we provide a model of Rust MIR in K.
3+
In this repository, we provide a model of the semantics of Rust's Stable MIR in K to enable symbolic execution of Rust programs and proofs of program properties.
44

5-
NOTE: This project is currently under reconstruction with changes and work outlined in [Polkadot Referendum #749](https://polkadot.subsquare.io/referenda/749). Some features you may be familiar with (concrete execution and symbolic execution) are currently removed while project foundations are improved.
6-
7-
Currently, the project is working to stabilize the serialized output of stable MIR (see our current [Rust PR](https://github.com/rust-lang/rust/pull/126963)) and develop the semantics for this output.
8-
9-
If you would like to try a legacy version of the project, [this blog post](https://runtimeverification.com/blog/introducing-kmir) has a tutorial on how to get started. However, it is important to install a legacy version for this to work, so when the tutorial prompts to install the latest version of KMIR with `kup install kmir`, this should be replaced instead with `kup install kmir --version v0.2.21`
5+
Also included is the `kmir` tool, a python script that acts as a front-end to the semantics.
106

117

128
## For Developers
@@ -25,7 +21,7 @@ For interactive use, spawn a shell with `poetry -C kmir/ shell` (after `poetry -
2521

2622
### Stable-MIR-JSON Setup
2723

28-
At the moment, to interact with some of KMIR functionalities, it is necessary to provide the tool with a serialized JSON of a Rust program's Stable MIR. To be able to extract these serialized SMIR JSONs, you can use the `Stable-MIR-JSON` tool, setting it up with the following commands:
24+
To interact with some of KMIR functionalities, it is necessary to provide the tool with a serialized JSON of a Rust program's Stable MIR. To be able to extract these serialized SMIR JSONs, you can use the `Stable-MIR-JSON` tool, setting it up with the following commands:
2925

3026
```Rust
3127
git submodule update --init --recursive
@@ -47,3 +43,9 @@ Use `--help` with each command for more details.
4743
`kmir prove run` to run the prover on a spec generated by `gen-spec`.
4844

4945
`kmir prove view` to run the KCFG visualizer and inspect the proof steps.
46+
47+
### Supporters
48+
49+
KMIR / mir-semantics is supported by funding from the following sources:
50+
- [Polkadot Open Gov](https://polkadot.subsquare.io/referenda/749)
51+
- Solana

kmir/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
44

55
[tool.poetry]
66
name = "kmir"
7-
version = "0.3.112"
7+
version = "0.3.113"
88
description = ""
99
authors = [
1010
"Runtime Verification, Inc. <[email protected]>",

kmir/src/kmir/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
from typing import Final
22

3-
VERSION: Final = '0.3.112'
3+
VERSION: Final = '0.3.113'

package/version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.3.112
1+
0.3.113

0 commit comments

Comments
 (0)