jpsacha / scalafx

ScalaFX simplifies creation of JavaFX-based user interfaces in Scala.

ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 8 and JavaFX 2.2. This means that every ScalaFX application is also a valid Scala application. By extension it supports full interoperability with Java and can run anywhere the Java Virtual Machine (JVM) and JavaFX 8 or JavaFX 2.2 are supported.

ScalaFX was originally created by Stephen Chin, Java Champion, Oracle JavaOne program chair; and Sven Reimers, a member of the Netbeans Dream Team.

There are two branches of ScalaFX: v.8.0 supporting JavaFX 8 (Java 8) and v.2.2 supporting JavaFX 2.x (Java 7).

ScalaFX binaries are published in the Maven Central repository: http://search.maven.org/#search|ga|1|scalafx

To use ScalaFX with SBT and Java 8 add following dependency:

libraryDependencies += "org.scalafx" %% "scalafx" % "8.0.31-R7"

With Java 7 use:

libraryDependencies += "org.scalafx" %% "scalafx" % "2.2.76-R11"

The ScalaFX Organization page on GitHub contains several sample project that illustrate use of ScalaFX. The simplest one, and recommended to start with, is scalafx-hello-world.

Snapshot releases are also regularly published on Sonatype. To use a snapshot build you may need to add "Sonatype OSS Snapshots" resolver to you SBT configuration:

resolvers += Opts.resolver.sonatypeSnapshots 

If you just want to download a recent snapshot build you can also use Travis CI build site https://travis-ci.org/scalafx/scalafx

ScalaFX source code is using the SBT build system. For information on building with SBT see README-SBT.txt.

The official web site for ScalaFX is http://scalafx.org.

#Software License

This software licensed under BSD Open Source.

The License text for this software can be found in LICENSE.txt in the root folder of the project.

#Software Required

The following software is needed to build ScalaFX:

1. SBT v.0.13.5 or better
2. Scala - ScalaFX 8.0 builds with Scala 2.10.2 or newer. - ScalaFX 2.2 builds with either Scala version 2.9.3+, 2.10.+, or 2.11.+

It works with Windows, MacOS X and Linux ports.

#Project Structure

The current project structure looks like this:

./archive
./project
./scalafx
./scalafx-demos

Where . is a the root folder of the project.

The archive folder is reserved for remnants of the previous single module build system.

The scalafx folder is the sub project for the ScalaFX Framework.

The scalafx-demos is the sub project for the ScalaFX Framework Demonstrations (some are a bit out of date, help needed here :).

The project folder is reserved for Scala SBT.

#Source Code Branching Policy

Main development is for ScalaFX 8 and it is done on the master branch. ScalaFX 2.2 development is done on SFX-2 branch. Features that are common to v.2 and v.8 should be commited to SFX-2, as merging os done only in one direction: from SFX-2 into main.

Pull requests are only accepted off master and SFX-2 or their branches. When working on a pull request, it is recommended to create separate branch for each feature or bug fix. This way the main development branch is not blocked by a pull request and pull requests are easier to merge individually.

Releases are done on stable and SFX-2-stable branches for ScalaFX 8 and ScalaFX 2, respectively. Releases are tagged with version number.

#Credits

You can find the full list of committers, developers and contributors in the file MAINTAINERS.txt.