FStar

(โ˜… 3,100)

A Proof-oriented Programming Language

Showing a partial file list โ€” download the zip above to see everything.

  • .gitattributes
  • .gitignore
  • .gitmodules
  • .ignore
  • .merlin
  • CHANGES.md
  • CONTRIBUTING.md
  • flake.lock
  • flake.nix
  • FStar.fst.config.json
  • fstar.opam
  • INSTALL.md
  • karamel
  • LICENSE
  • LICENSE-fsharp.txt
  • Makefile
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/FStarLang/FStar

Downloads the entire project code from GitHub to your computer.

cd FStar

Moves into the project folder you just downloaded.

2. .NET

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd fsharp/VS

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

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

โœ… After dotnet run, check the message or address shown in the terminal.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd pulse/pulse2rust/dpe

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/.

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 .scripts/fstardoc

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