INSTALL

Installing Starling
===================

Installing on OSX 
-----------------

(Instructions written by MDD 16-12-15. Roughly these instructions will work on
Linux as well) 

- Download and install: 
  * mono from http://www.mono-project.com/download/
  * fsharp from https://github.com/fsharp/fsharp
  * Nuget from https://www.nuget.org/nuget.exe
  * starling from https://github.com/septract/starling-tool

- Download z3 from https://github.com/Z3Prover/z3
  * Build according to the following instructions, taken from 
      http://luajalla.azurewebsites.net/z3-mono-starter/ 
  * Generate the makefiles: 
    > python scripts/mk_make.py
    > cd build
  * Edit config.mk to switch to 32-bin arch: 
     1: CXXFLAGS= -D_MP_INTERNAL -m32  -c -D_NO_OMP_ -mfpmath=sse -O3 -D _EXTERNAL_RELEASE -fomit-frame-pointer -fPIC -msse -msse2
     2: LINK_FLAGS=-m32
     3: SLINK_FLAGS=-dynamiclib -m32
  * run 'make & make install'
[Note: I'm not sure whether altering config.mk is strictly necessary -- MDD] 

- In the starling-tool directory, run the following to download packages
  > mono /path/to/NuGet.exe restore packages.config -PackagesDirectory packages

- In starling-tool, build starling by running 
  > xbuild starling.sln

- The binary will be starling-tool/bin/Debug/starling.exe

- Run the NUnit tests by running: 
 > mono [path to NUnitConsolerunner]/tools/nunit3-console.exe bin/Debug/starling.exe