verus

(โ˜… 2,881)

Verified Rust for low-level systems code

  • .git-blame-ignore-revs
  • .gitignore
  • BUILD.md
  • CONTRIBUTING.md
  • INSTALL.md
  • LICENSE
  • README.md
  • rust-toolchain.toml

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/verus-lang/verus

Downloads the entire project code from GitHub to your computer.

cd verus

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd dependencies/prettyplease

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

3. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
cd source/docs/verus

This project's files live in a subfolder, so move into it first.

bundle install

Installs the Ruby libraries listed in the Gemfile.

โœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd source/docs/publications-and-projects

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation