From ed7e0938a201ebe86d9b05db92f63da9c87dcc2b Mon Sep 17 00:00:00 2001 From: Rowan Torbitzky-Lane Date: Fri, 7 Mar 2025 13:14:17 -0600 Subject: [PATCH] how to run instructions --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ec66631..a7ddf05 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ I am developing this library using: - GHC 9.8.2 - Cabal 3.12.1.0 +## How to run + In order to run this library. There is some manual configuration needed. For an example, check out `src/HushGP/Problems/IntegerRegression.hs`. This contains the parts needed for a full evolutionary run. @@ -16,6 +18,9 @@ The user is expected to provide their own data, their own fitness function, and they would like to use. This set can be found in the files of `src/HushGP/Instructions`. You can also check the haddock documentation for lists of these as well. +The best way to run this library is to use cabal. `cabal repl` for development. TODO: Command for +fully compiling and building an executable to run. + # Building Instructions In order to build Hush with hmatrix, `lapack` development libraries must be installed on your