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. See README.nix.md for instructions for using Forester with nix.

Contributing#

Please mail patches by email to ~jonsterling/forester-devel@lists.sr.ht. General discussion can be mailed to ~jonsterling/forester-discuss@lists.sr.ht.

When you prepare patches, please be sure that all code is formatted as follows:

dune build @fmt
dune promote

Patches will not be rejected on grounds of poor formatting but they may be reformatted before being applied.

Join us on IRC

Example Use#

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