Seer User Guide

Getting Started

Prerequisites

Make sure you have java installed, javac -version should return a version number. If not, install JDK 7 or OpenJDK 7.

You will also need git.

Download Seer

Seer source code is available on github and can be dowloaded by running:

git clone https://github.com/fishuyo/seer.git

If you want to get started building your own project see using Seer Template Project below.

Building and Running Examples

Seer uses sbt to build and run projects.

Sbt has an interactive mode, which lets you navigate different sub-projects of the build and run commands on them. To launch sbt run from within the seer directory:

./sbt

The first time you run this it may take a few minutes to reach the sbt command prompt. This executes a script which when run for the first time downloads sbt and some unmanaged dependencies necessary to build seer, and then launches sbt.

Once you reach the sbt prompt designated by a ">" try running the following commands:

project examples
run

The first command switches the currently selected project to the 'examples' project. The 'run' tells sbt to run the Main class of the project, which first requires that all of the project's dependencies be fetched and successfully compiled.

If a project has more than one Main class it will ask you to enter a number to choose which one to run.

It is also possible to run commands without starting sbt in interactive mode. To build the basic examples try running the following from within the seer directory:

./sbt 'project examples' run

Seer has a few different example subprojects to show how to use different modules of seer. Check them all out. Run ./sbt projects to list all of the projects in the build.

To learn more about using sbt go here.

Seer Template Project

If you want to make your own project that uses Seer and its modules you can get started quickly by cloning the seer-template-project:

git clone https://github.com/fishuyo/seer-template-project.git project-name

After cloning, run ./init from inside the cloned project-name directory. This downloads Seer as a submodule.

Run the template projects example main with ./sbt run