<commit_before>## Table of Contents ##

  * [Online editor](#online-editor)
  * [OPAM package](#opam-package)
  * [Binary package](#binary-package)
    * [Installing a binary package](#installing-a-binary-package)
    * [Using a binary package to compile OCaml code generated by F*](#using-a-binary-package-to-compile-ocaml-code-generated-by-f)
    * [Testing a binary package](#testing-a-binary-package)
  * [Running F* from a docker image](#running-f-from-a-docker-image)
  * [Chocolatey Package on Windows](#chocolatey-package-on-windows)
  * [Building F* from the OCaml sources](#building-f-from-the-ocaml-sources)
    * [Prerequisites: Working OCaml setup](#prerequisites-working-ocaml-setup)
      * [Instructions for Windows](#instructions-for-windows)
      * [Instructions for Linux and Mac OS X](#instructions-for-linux-and-mac-os-x)
      * [Instructions for all OSes](#instructions-for-all-oses)
    * [Building F* and the libraries](#building-f-and-its-libraries)
  * [Bootstrapping F* in OCaml](#bootstrapping-f-in-ocaml)
    * [Step 1. Build an F* binary from OCaml snapshot](#step-1-build-an-f-binary-from-ocaml-snapshot)
    * [Step 2b. Extract the sources of F* itself to OCaml](#step-2b-extract-the-sources-of-f-itself-to-ocaml)
    * [Repeat Step 1](#repeat-step-1)
  * [Runtime dependency: Particular version of Z3](#runtime-dependency-particular-version-of-z3)

## Online editor ##

The easiest way to try out F\* quickly is directly in your browser by
using the [online F\* editor] that's part of the [F\* tutorial].

[online F\* editor]: https://www.fstar-lang.org/run.php
[F\* tutorial]: https://www.fstar-lang.org/tutorial

## OPAM package ##

If the OCaml package manager (OPAM version 2.0 or later) is present on your platform,
you can install the latest development version of F\* (`master` branch) and
required dependencies using the following command:

    $ opam pin add fstar --dev-repo

To instead install the latest released version you can use the following command
(keeping in mind that you will often get an old version of F\* this way,
so unless a release happened recently we don't really recommend it;
moreover, you will need to [install z3 separately](#runtime-dependency-particular-version-of-z3)):

    $ opam install fstar

Note: To install OCaml and OPAM on your platform please read the
[Working OCaml setup](#prerequisites-working-ocaml-setup)
section further below, steps 0 to 3.

Note: On MacOS you will additionally need to install `coreutils`
via Homebrew or Macports for the OPAM package of F\* to work
(see [issue #469](https://github.com/FStarLang/FStar/issues/469)).


## Binary package ##<commit_msg>update INSTALL.md to indicate that installing z3 separately is not needed anymore when using opam<commit_after>## Table of Contents ##

  * [Online editor](#online-editor)
  * [OPAM package](#opam-package)
  * [Binary package](#binary-package)
    * [Installing a binary package](#installing-a-binary-package)
    * [Using a binary package to compile OCaml code generated by F*](#using-a-binary-package-to-compile-ocaml-code-generated-by-f)
    * [Testing a binary package](#testing-a-binary-package)
  * [Running F* from a docker image](#running-f-from-a-docker-image)
  * [Chocolatey Package on Windows](#chocolatey-package-on-windows)
  * [Building F* from the OCaml sources](#building-f-from-the-ocaml-sources)
    * [Prerequisites: Working OCaml setup](#prerequisites-working-ocaml-setup)
      * [Instructions for Windows](#instructions-for-windows)
      * [Instructions for Linux and Mac OS X](#instructions-for-linux-and-mac-os-x)
      * [Instructions for all OSes](#instructions-for-all-oses)
    * [Building F* and the libraries](#building-f-and-its-libraries)
  * [Bootstrapping F* in OCaml](#bootstrapping-f-in-ocaml)
    * [Step 1. Build an F* binary from OCaml snapshot](#step-1-build-an-f-binary-from-ocaml-snapshot)
    * [Step 2b. Extract the sources of F* itself to OCaml](#step-2b-extract-the-sources-of-f-itself-to-ocaml)
    * [Repeat Step 1](#repeat-step-1)
  * [Runtime dependency: Particular version of Z3](#runtime-dependency-particular-version-of-z3)

## Online editor ##

The easiest way to try out F\* quickly is directly in your browser by
using the [online F\* editor] that's part of the [F\* tutorial].

[online F\* editor]: https://www.fstar-lang.org/run.php
[F\* tutorial]: https://www.fstar-lang.org/tutorial

## OPAM package ##

If the OCaml package manager (OPAM version 2.0 or later) is present on your platform,
you can install the latest development version of F\* (`master` branch) and
required dependencies using the following command:

    $ opam pin add fstar --dev-repo

To instead install the latest released version you can use the following command
(keeping in mind that you will often get an old version of F\* this way,
so unless a release happened recently we don't really recommend it):

    $ opam install fstar

Note: To install OCaml and OPAM on your platform please read the
[Working OCaml setup](#prerequisites-working-ocaml-setup)
section further below, steps 0 to 3.

Note: On MacOS you will additionally need to install `coreutils`
via Homebrew or Macports for the OPAM package of F\* to work
(see [issue #469](https://github.com/FStarLang/FStar/issues/469)).


## Binary package ##
{'fraction_non_alphanumeric': 0.12056603773584906, 'fraction_numerical': 0.007358490566037735, 'mean_word_length': 4.191968658178257, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '588436', 'n_tokens_mistral': 1726, 'n_tokens_neox': 1601, 'n_words': 552}