Skip to content

Commit

Permalink
README: Update
Browse files Browse the repository at this point in the history
  • Loading branch information
Lysxia committed Dec 12, 2024
1 parent 3c5d130 commit 5ea6df8
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 153 deletions.
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,10 @@ Creusot IDE consists of two parts:

2. The **Creusot LSP language server**, which must currently be installed separately:

git clone https://github.com/creusot-rs/creusot-ide
opam pin creusot-lsp creusot-ide/
# Say yes to install creusot-lsp

Creusot LSP currently depends on development versions of Why3 and Why3find.
(Tested with Why3 commit `9c0548a62` and Why3find commit `7f728e9` + temporary [local patch](./why3find.patch))
# First, install Creusot, Why3, and Why3find; see https://github.com/creusot-rs/creusot for instructions

git clone https://gitlab.inria.fr/why3/why3
opam pin why3 why3#9c0548a62

git clone https://git.frama-c.com/pub/why3find
cd why3find
git checkout 7f728e9
git apply ../creusot-ide/why3find.patch
git commit -am "patch"
opam pin why3find .
cd ..
git clone https://github.com/creusot-rs/creusot-ide
opam pin creusot-lsp creusot-ide/ -y

## Features

Expand All @@ -45,12 +32,18 @@ Creusot IDE helps you nagivate between your Rust sources and the verification ar
- Functions with proof obligations will have a button in the gutter to their left.
Click to run the prover (`why3find prove`).
Alt+click to start Why3 IDE (only if the prover fails).
- Links in your editor between fragments of Rust code and their counterparts in the generated Coma and proof files.
- Display hypotheses and goal at various point of the proof.
- Diagnostics underline locations with failed proofs
- Syntax highlighting:
- `.rs` files: Creusot-specific attributes and Pearlite expressions,
- `.coma` files.

## Commands

Available in the command palette (`Ctrl+P`):

- Restart language server
- Stop language server

## Settings

- `creusot.lspPath`: Path to the `creusot-lsp` executable. Default: `""`, to find the executable in `PATH`.
Expand Down
135 changes: 0 additions & 135 deletions why3find.patch

This file was deleted.

0 comments on commit 5ea6df8

Please sign in to comment.