package forester

README.md

This is the source repository for the forester tool, which is implemented in the OCaml programming language. Please see this page for more information.

System Requirements

You need to have OCaml 5 and opam installed.

Installation

You can install forester by running opam install forester. For the current prerelease, you must first pin an unreleased version of dream-html; we will wait until the latter is released until we release a new version of Forester.

opam pin add dream-html git+https://github.com/yawaramin/dream-html

Using nix (Optional)

Forester can also be used with nix. To run forester, use nix run sourcehut:~jonsterling/ocaml-forester. If you are working with a Nix flake-based project and want to include Forester as a build input, you can add it to your flake.nix:

{
  inputs = {
    forester.url = "sourcehut:~jonsterling/ocaml-forester";
    forester.inputs.nixpkgs.follows = "nixpkgs";
  };

  outputs = inputs@{ self, forester, nixpkgs }:
    let
      system = "x86_64-linux"; # make sure to change this to your use case!
      pkgs = import nixpkgs { inherit system inputs; };
    in
    {
      devShells.${system}.default = pkgs.mkShell {
        buildInputs = [ forester.packages.${system}.default ];
      };
    };
}

Example Use

Please see my Forest for an example of using forester, or clone your own template forest.