Build instructions

Magic-trace is written in OCaml. It uses opam as its package manager, and dune as its build system.

1. Install opam

bash -c "sh <(curl -fsSL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)"
opam init --bare

2. Select the 4.13.1 OCaml compiler

opam switch create 4.13.1 4.13.1
eval $(opam env --switch=4.13.1)

3. Add the ability to fetch some extra dependencies

opam repo add janestreet-bleeding https://ocaml.janestreet.com/opam-repository

4. Clone the magic-trace repo

git clone https://github.com/janestreet/magic-trace.git magic-trace
cd magic-trace

5. Install dependencies

opam install ./magic-trace.opam --deps-only
opam install ocamlformat

6. Build, test, and autoformat it

dune build @default @runtest @fmt --auto-promote

7. Run it

_build/default/bin/magic_trace_bin.exe -help

8. Set up your editor.

9. Hit up the issue tracker to find a bug to work on.