From 75603e0bf465cf04c4493271daa72283e568af8f Mon Sep 17 00:00:00 2001 From: l-kent <56100168+l-kent@users.noreply.github.com> Date: Mon, 22 Jul 2024 10:56:39 +1000 Subject: [PATCH] Update readme.md Add information for using Mill with Windows --- readme.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 42e507c9e..b17d5ee3e 100644 --- a/readme.md +++ b/readme.md @@ -35,13 +35,21 @@ Boogie program verifier finished with 4 verified, 0 errors The tool takes as inputs either a BAP ADT file (here denoted with `.adt`) or a `.gts` file produced by [gtirb-semantics](https://github.com/UQ-PAC/gtirb-semantics), as well as a file containing the output of readelf (here denoted with `.relf`), both created from the same AArch64/ARM64 binary, and outputs a semantically equivalent .bpl Boogie-language source file. The default output file is `boogie_out.bpl`, but the output location can be specified. -To build and run the tool using sbt, use the following command: +To build and run the tool use one of the the following commands: -`sbt "run --input file.{adt, gts} --relf file.relf [--spec file.spec] [--output output.bpl] [--analyse] [--interpret]"` where the output filename is optional and specification filenames are optional. The specification filename must end in `.spec`. - -or mill: - -`mill run --input file.adt --relf file.relf [--spec file.spec] [--output output.bpl] [--analyse] [--interpret]`. +sbt: +``` +sbt "run --input file.{adt, gts} --relf file.relf [--spec file.spec] [--output output.bpl] [--analyse] [--interpret]" +``` +mill (Mac OS X / Linux): +``` +./mill run --input file.adt --relf file.relf [--spec file.spec] [--output output.bpl] [--analyse] [--interpret] +``` +mill (Windows): +``` +./mill.bat run --input file.adt --relf file.relf [--spec file.spec] [--output output.bpl] [--analyse] [--interpret] +``` +The output filename is optional and specification filenames are optional. The specification filename must end in `.spec`. #### Usage @@ -82,9 +90,14 @@ See [docs/development](docs/development) 2. Install [boogie](/docs/development/tool-installation.md) 3. To a single system test case : +Mac OS X / Linux: ``` ./mill test.testOnly '*SystemTests*' -- -z secret_write -z secret_write ``` +Windows: +``` +./mill.bat test.testOnly '*SystemTests*' -- -z secret_write -z secret_write +``` ## Open Source License