diff --git a/README.md b/README.md index 7e3e7eb78..e9312659b 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ If you would like to try a legacy version of the project, [this blog post](https ## For Developers -### Setup +### KMIR Setup -Pre-requisites: `python >= 3.10`, `pip >= 20.0.2`, `poetry >= 1.3.2`. +Pre-requisites: `python >= 3.10`, `pip >= 20.0.2`, `poetry >= 1.3.2`, `gcc >= 11.4.0`, `cargo == nightly-2024-11-29`, `k >= v7.1.205`. To install K, follow the steps available in [K's Quick Start instructions](https://github.com/runtimeverification/k?tab=readme-ov-file#quick-start). ```bash make build @@ -23,6 +23,17 @@ Use `make` to run common tasks (see the [Makefile](Makefile) for a complete list For interactive use, spawn a shell with `poetry -C kmir/ shell` (after `poetry -C kmir/ install`), then run an interpreter. Or directly run from `mir-semantics` root with `poetry run -C kmir kmir ` +### Stable-MIR-JSON Setup + +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: + +```Rust +git submodule update --init --recursive +make stable-mir-json +``` + +For more information on testing, installation, and general usage of this tool, please check [Stable-MIR-JSON's repository](https://github.com/runtimeverification/stable-mir-json/). + ## Usage Use `--help` with each command for more details. diff --git a/kmir/pyproject.toml b/kmir/pyproject.toml index e888fe016..fb8df5298 100644 --- a/kmir/pyproject.toml +++ b/kmir/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "kmir" -version = "0.3.106" +version = "0.3.107" description = "" authors = [ "Runtime Verification, Inc. ", diff --git a/kmir/src/kmir/__init__.py b/kmir/src/kmir/__init__.py index 7b94866af..e69cf1174 100644 --- a/kmir/src/kmir/__init__.py +++ b/kmir/src/kmir/__init__.py @@ -1,3 +1,3 @@ from typing import Final -VERSION: Final = '0.3.106' +VERSION: Final = '0.3.107' diff --git a/package/version b/package/version index 95d7f727b..0793ec760 100644 --- a/package/version +++ b/package/version @@ -1 +1 @@ -0.3.106 +0.3.107