NickHu / homotopy-io

Rewritten homotopy-core
3 stars 2 forks source link

Document build instructions #8

Open NickHu opened 4 years ago

NickHu commented 4 years ago

Add a README; give a brief overview of the build tools we are using

jamievicary commented 4 years ago

It would be great if someone could do this. I wanted to try to build the new code this afternoon, but couldn't really get started.

NickHu commented 4 years ago

The basic build instructions are as follows (I just tested this on a fresh Windows machine, will write up properly later):

  1. Install purescript compiler and spago build tool
    • There is a shell.nix provided for Nix
    • On Windows, the recommended way of doing this is via npm install -g purescript spago
  2. In the relevant directory, e.g. core or webclient, run spago build

The compiled code can be played around with in the repl (spago repl); currently, there isn't much of a user interface.

jamievicary commented 4 years ago

Thanks, it's working.