Tokanagrammar / tokanagrammar-dev

Development branch (This includes all discussions and plannings)
http://tokanagrammar.github.com/
GNU Lesser General Public License v3.0
2 stars 2 forks source link

tokanagrammar- Development Branch.

This is the development branch of tokanagrammar. For stable, well tested code, see tokanagrammar/tokanagrammar

This is a jigsaw-like puzzle game, except each piece is token from a source file, and the 'complete picture' is the program.

Adding puzzles to the game

See instructions here.

Set up Development Environment

0) Install Maven (3.0.4 or later) (See instructions on their site)

1) You want to make sure you have jdk 1.7.0_u14 (or later, the current version (as of March, 22, 2013) is jdk 1.7.0_u17)

2) Install JavaFx

mvn install:install-file -Dfile=jfxrt.jar -DgroupId=com.oracle -DartifactId=javafx -Dpackaging=jar -Dversion=2.2.7

Note #1 2.2.7 should be replaced with whatever your C:\Program Files\Java\jre7\lib\javafx.properties says the version is.

Note #2 If you are on a Unix/Linux environment, copy the jar to ~/ (ie., your home directory)

This step is sort of a 'workaround' to some bug. Once Oracle fixes this (hopefully in Java8, which is released this summer), we should be able to skip this, because, as they promised, JavaFX will be included natively in Java (just like Swing or other built-in APIs)

CHEATSHEET

This is a maven project, and build phase requires every source file to have a header.

0) Be sure you get the right version of Java (and Maven)

1) To automatically prepend a header:

mvn license:format

2) To check for missing headers:

mvn license:check

3) To build runnable jar:

mvn clean package

This will produce an executable jar file in <project root dir>/target/.

The jar can be run anywhere, but it needs to have the config and the puzzles directory.

4) To run all unit tests

mvn clean test

5) To build binary tar.gz package (containing executable)

./build_binaries.sh

6) To build binary zip package (on Windows)

build_binaries.cmd

Note This script requires 7z to be already installed.

7) To build Apple OSX executable app

./build_binaries.sh macosx

Directory Structures

Please follow the conventions and put things in the right place. See this