Hardcaml can be installed with opam We highly recommend using Hardcaml with OxCaml a bleeding edge OCaml compiler which includes some Jane Street compiler extensions and maintains the latest version of Hardcaml Note that when looking at Hardcaml GitHub repositories the OxCaml version is in a branch named Install opam the OxCaml compiler and some basic developer tools to get started For additional information on setting up the OCaml toolchain and editor support see Real World OCaml We recommend the following Hardcaml packages to get started This will install the core Hardcaml library a waveform viewer which is helpful for building tests and the hardcaml ppx as well as an OCaml standard library and build system with extensions opam install hardcaml hardcaml_waveterm ppx_hardcaml core utop dune

Hardcaml can be used with utop or another OCaml top level This provides a great environment to learn the API The following utop command makes things nicer to play with #require hardcaml open Hardcaml Bits #install_printer Bits pp

The following is an example Dune file for linking to Hardcaml Note that has to be explicitly specified as a preprocessor when writing Hardcaml sources ppx_hardcaml library name my_hardcaml_lib libraries base hardcaml preprocess pps ppx_jane ppx_hardcaml

If you encounter any bugs or issues with the open source Hardcaml release please report them on the Hardcaml GitHub