INSTALL

Quick Installation Guide for another-elm
========================================


another-elm comes with a wrapper script of the same name. The wrapper should be
a drop in replacement for the offical elm compiler.


Prerequisites
-------------

The wrapper script is written in python, a non-eol needs to be installed to run
the wrapper. The official elm compiler must also be installed.


Supported Elm Versions
----------------------

We support the latest version of elm, older versions may be supported but that
support may be removed at any time.


Build and Installation Procedure
--------------------------------

To install another-elm to "~/.local/bin":

   ANOTHER_ELM_DIR="${XDG_DATA_HOME:-~/.local/share}/another-elm"
   mkdir -p "$ANOTHER_ELM_DIR"
   cd "$ANOTHER_ELM_DIR"
   git clone https://github.com/another-elm/std
   cd std
   ./init.py


Checking for Successful Installation
------------------------------------

Currently it is hard to work out if the installation worked correctly. In the
future we will automate this. For now, here is a usefull test: if the compiler
generates javascript contains "$elm$core$Platform$Raw$Scheduler" then
another-elm has been correctly installed.