1. Fantom Readme

Setup

  1. Ensure "{home}/bin" is in your path
  2. Fantom launcher:
    • Unix: "bin/fan" bash script
    • Windows: "bin/fan.exe" executable
  3. Verify setup "fan -version"

For further information see docTools::Setup

Tools

Common tools you will use:

  • fan: Fantom launcher for scripts and pods
  • fansh: Fantom interactive shell
  • fant: Fantom test runner
  • IDEs: different IDE and editor options

For further information see docTools

Docs

The documentation maybe found online at http://fantom.org/doc/.

You may also build the HTML docs in your local environment using the command:

fan compilerDoc -all

This will generate the HTML docs for all the pods found in your local working environment.

Community