Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.33 KB

INSTALL.md

File metadata and controls

60 lines (41 loc) · 2.33 KB
Raw

Installation from source

Touist is composed of:

  • touist is the command-line tool for solving .touist problems
  • touist.jar, (in support/gui/) is a graphical interface for touist.

Building touist (the OCaml binary)

Prerequisites

Before you go, make sure you have OCaml installed. To install it:

apt install ocaml                    # Ubuntu
brew install ocaml                   # MacOS

Then, install the OPAM (OCaml package manager) dependencies:

opam init -y
opam install . --deps-only --with-test

Build on Linux & MacOS

Common development commands:

Command What it does
opam exec dune build @fmt --auto-promote Reformat .ml and dune files
opam exec dune exec -- touist Compile and run touist
opam exec dune runtest Run the unit and integration tests (*.t = cram tests)
opam install . --working-dir Install touist on your PATH so that you can use it anywhere
opam uninstall . Uninstall it

Build it on windows

You will need to get Cygwin + OCaml to build a native touist binary. Follow the instructions for installing Opam and Ocaml on windows (visited on 2016-10-26). Thanks to fdopen on github, we have opam on windows! After installing cygwin, please refer to ci/appveyor-script.sh for the different build steps.

What are the dune files?

As you probably noticed, there are many files named dune. These files contain the instructions so that dune can builder everything. I know that it is using s-expressions and that people prefer json or yaml (to be fair, me too) and that there is no syntax highlighting or anything. But dune is very nice and more importantly, fast and maintained.

Building the Java GUI (touist.jar)

Steps:

  1. first, build touist (see above)
  2. go to support/gui and run ./gradlew build (see support/gui/INSTALL.md for more details)
  3. to run it, you can do ./gradlew run