https://ocamlpro.github.io/verification_for_dummies/

Induction as a formal program verification technique for the uninitiated, written in Rust.
https://ocamlpro.github.io/verification_for_dummies/

Last synced: 3 months ago
JSON representation

Induction as a formal program verification technique for the uninitiated, written in Rust.

• Host: GitHub
• URL: https://ocamlpro.github.io/verification_for_dummies/
• Owner: OCamlPro
• Created: 2021-09-29T13:20:22.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-09-12T15:46:32.000Z (about 2 years ago)
• Last Synced: 2024-05-22T22:33:52.530Z (6 months ago)
• Language: Rust
• Homepage:
• Size: 1.5 MB
• Stars: 4
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-rust-formalized-reasoning - Verification for Dummies: SMT and Induction - broadly discusses induction as a formal verification technique. (Resources / Books)

README

        
# Induction For Dummies



    



This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Induction as a formal program verification technique for the uninitiated.

## Building

> This book relies mostly on [`mdbook`] and [`mdbook-linkcheck`].

[Install Rust] if you haven't already, make sure it's not outdated, and retrieve the dependencies.

```bash

# Update Rust toolchain.

> rustup update

# Install/update `mdbook` and `mdbook-linkcheck`.

> make update_deps

```

Use the [`manager`](#Manager) to run the tests if you want, but be aware that this requires the

binaries for [Z3] and mikino to be in your path. You can download its latest release [here][Z3

releases].

```bash

> make test

# or

> cargo run

```

## Manager

The manager is written in Rust, its code is in the `manage` directory. It is responsible for

testing the whole book. This relies mostly on [`mdbook`] and [`mdbook-linkcheck`], but the manager

also tests all files appearing in a `code` directory inside `src` (recursively).

Such a file `file.ext` is expected to either

- be a Rust file (`ext` is `rs`), meaning they are tested by [`mdbook`] if reachable, or

- have an associated `file.ext.out` *output* file.

The output file contains the output of running a certain command on `file.ext`, which depends on

`ext`. For instance, `file.smt2` should have a `file.smt2.out` companion file containing the output

of `z3 file.smt2`.

## License

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

To view a copy of this license, visit  or send a

letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

[Install Rust]: https://www.rust-lang.org/tools/install

(Rust installation homepage)

[`mdbook`]: https://github.com/rust-lang/mdBook

(mdbook on github)

[`mdbook-linkcheck`]: https://github.com/Michael-F-Bryan/mdbook-linkcheck

(mdbook-linkcheck on github)

[Z3]: https://github.com/Z3Prover/z3

(Z3 on github)

[Z3 releases]: https://github.com/Z3Prover/z3/releases

(Z3 releases on github)