Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.13 KB

INSTALL.md

File metadata and controls

39 lines (26 loc) · 1.13 KB

Cámlmon Installation Instructions

System Requirements

  • Ocaml 4.12.x

Installation Instructions

These instructions assume that you have OCaml and opam installed as per the Install OCaml module in the CS 3110 Canvas.

  1. Run the following command to install pkg-config.

    Mac (Pick One):
    brew install pkg-config
    sudo port install pkgconfig

  2. You will need to install a couple packages in order to play the game. Run the following command:
    opam install oUnit ASNITerminal sdl2

  3. You will need an XServer to display the graphics. Please make sure that the XServer is open before completing step 5.

    Windows: XMing [XMing] https://sourceforge.net/projects/xming/

    Mac: XQuartz [XQuartz] https://www.xquartz.org/

  4. Run make build in the root directory and this will build the the necessary modules needed to run this code.

  5. Run make play to start playing!

Commands for Building the System and Running

  • make build builds the modules needed to run the project
  • make test evaluates the test cases in test.ml
  • make play initializes and plays the game