unicorn/bindings/haskell/README.TXT

This documentation explains how to install Haskell binding for Unicorn
from source.


0. Install the core engine as dependency

   Follow README in the root directory to compile & install the core.

   On *nix, this can simply be done by (project root directory):

        $ sudo ./make.sh install


1. Change directories into the Haskell bindings, build and install

    $ cd bindings/haskell
    $ cabal install --dependencies-only
    $ cabal configure
    $ cabal build
    $ cabal install

If you are installing into a sandbox, run `cabal sandbox init` before
installing Unicorn's dependencies.

If the build fails, install c2hs manually `cabal install c2hs` (note that this
will probably also require you to run `cabal install alex` and `cabal install
happy` as well). If you are NOT using a sandbox, ensure that `$HOME/.cabal/bin`
is on your PATH.
Haskell bindings These Haskell bindings make large use of c2hs to generate much of the code, so Unicorn's const_generator is not used. The emulator is based on the Either monad transformer. The IO monad is used to run the underlying Unicorn library, while the Either monad is used to handle errors. Instructions on how to build the bindings are located in bindings/haskell/README.TXT. The same samples found in samples/ can be found in bindings/haskell/samples. They should produce the same output, with slight differences in their error handling and messaging. 2016-04-05 23:21:36 +00:00			`This documentation explains how to install Haskell binding for Unicorn`
			`from source.`


			`0. Install the core engine as dependency`

			`Follow README in the root directory to compile & install the core.`

			`On *nix, this can simply be done by (project root directory):`

			`$ sudo ./make.sh install`


			`1. Change directories into the Haskell bindings, build and install`

			`$ cd bindings/haskell`
Fixed Makefile build step for Haskell bindings 2016-04-07 12:27:38 +00:00			`$ cabal install --dependencies-only`
			`$ cabal configure`
Haskell bindings These Haskell bindings make large use of c2hs to generate much of the code, so Unicorn's const_generator is not used. The emulator is based on the Either monad transformer. The IO monad is used to run the underlying Unicorn library, while the Either monad is used to handle errors. Instructions on how to build the bindings are located in bindings/haskell/README.TXT. The same samples found in samples/ can be found in bindings/haskell/samples. They should produce the same output, with slight differences in their error handling and messaging. 2016-04-05 23:21:36 +00:00			`$ cabal build`
			`$ cabal install`

Fixed Makefile build step for Haskell bindings 2016-04-07 12:27:38 +00:00			If you are installing into a sandbox, run `cabal sandbox init` before
			`installing Unicorn's dependencies.`

Updated Haskell README to make it clear that Alex and Happy are required for c2hs 2016-04-08 07:58:11 +00:00			If the build fails, install c2hs manually `cabal install c2hs` (note that this
			will probably also require you to run `cabal install alex` and `cabal install
			happy` as well). If you are NOT using a sandbox, ensure that `$HOME/.cabal/bin`
			`is on your PATH.`