{-# title: Building and Installing Bunny -}
# Building and Installing Bunny

## Build environment requirements

[Bunny](Bunny) can be built on Windows (MINGW) or Linux with GHC (Haskell Platform).
In addition to what is included in the Haskell Platform,
the following tools and libraries must be installed beforehand.

- Tools
  - GNU Make
  - HLint
  - Alex
  - Happy
- Libraries
  - ansi-wl-pprint
  - optparse-applicative

To make Android applications with Bunny,
[Android Studio](https://developer.android.com/studio)
and
[Android SDK Platform Tools](https://developer.android.com/studio/releases/platform-tools) are needed.

After installing Android Studio, you have to create at least one project
on your system because Bunny needs $<verb>{local.properties} file of it.

And you need to add $<verb>{jre/bin} of the Android Studio and $<verb>{platform-tools} of
the Android SDK Platform Tools into your $<verb>{PATH} environment variable.
By doing this, $<verb>{javac}, $<verb>{java} and $<verb>{adb} can be found in the `PATH`
like the following example.

$$<pre>{
# On Windows (MINGW)
$ which javac
/c/Program Files/Android/Android Studio/jre/bin/javac
$ which java
/c/Program Files/Android/Android Studio/jre/bin/java
$ which adb
/c/Users/<user name>/android/platform-tools/adb
$$}

$$<pre>{
# On Linux
$ which javac
/home/<user name>/android-studio/jre/bin/javac
$ which java
/home/<user name>/android-studio/jre/bin/java
$ which adb
/home/<user name>/Android/Sdk/platform-tools/adb
$$}

## Building

The Bunny project is built with GNU Make.

$$<pre>{
cd compiler
make
$$}

When succeeded, you can run the sample program on the same system you build
Bunny. 


$$<pre>{
bin/bunny testrun Hello.hs
$$}

This will print the following message.

$$<pre>{
Hello, World!
$$}

## Installing

Before installing Bunny to your system, you have to import
$<verb>{local.properties} from an Android Studio project.
This can be done like the following. MyFirstApp is just an example, and
please use the name of the project that you created by the Android Studio.

$$<pre>{
cp ~/AndroidStudioProjects/MyFirstApp/local.properties AndroidProjectPrototype/
$$}

Then you can install Bunny with $<verb>{./install.sh}.
The installation directory will be $<verb>{$HOME/bunny/0.9.0} by default.
If you want to change this, specify the path as an argument of $<verb>{./install.sh}.

$$<pre>{
./install.sh
$$}

As the $<verb>{./install.sh} will not change your $<verb>{PATH} environment variable,
the directory should be added manually to your $<verb>{PATH}.

## Usage

Run bunny with $<verb>{android} subcommand as shown below, it will compile the Haskell program and create an Android project containing the result of the compilation.

$$<pre>{
bunny android <source-file>
$$}

Then go to the directory and type $<verb>{. /gradlew} (or $<verb>{. /gradlew.bat} (on Windows)} to build your Android application.

Example:

$$<pre>{
bunny android sample/Hello.hs
cd ~/BunnyProjects/Hello
./gradlew assembleDebug
$$}