Gabriel95 / scalafx

Automatically exported from code.google.com/p/scalafx
Other
0 stars 0 forks source link

||| | |||| | |
| ||| ||| | ||| | | |
|| | | | | | | ||| |
| | | | | | | | | |
||| ||| ||| | ||| | | |

This is the `README.txt ' file for ScalaFX

  1. Introduction

ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8. 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 2.0 orJavaFX 8 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.1.0 supporting JavaFX 2.x (Java 7) and v.8.0 supporting JavaFX 8 (Java 8).

ScalaFX binaries are published in the Maven Central repository: http://search.maven.org/#search%7Cga%7C1%7Cscalafx

To use ScalaFX with SBT add following dependency:

libraryDependencies += "org.scalafx" % "scalafx_2.10" % "1.0.0-M7"

You can find a simple project setup in subdirectory "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 += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"

If you just want to download a recent snapshot build you can also use automated build site http://jfxtras.com/jenkins/job/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, currently hosted at https://code.google.com/p/scalafx/

  1. 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.

  1. Software Required

The following software is needed to build ScalaFX:

1) Mercurial (http://mercurial.selenic.com/) v2.2 or better 2) sbt (http://www.scala-sbt.org/) v0.13.1 or better 3) Scala (http://www.scala.org/)

It works with Windows, MacOS X and Linux ports.

  1. Project Structure

The current project structure looks like this:

./archive ./project ./scalafx ./scalafx/src ./scalafx/src/main ./scalafx/src/main/scala ./scalafx/src/main/resources ./scalafx/src/test ./scalafx/src/test/resources ./scalafx/src/test/scala ./scalafx-demos ./scalafx-demos/src ./scalafx-demos/src/main ./scalafx-demos/src/main/scala ./scalafx-demos/src/main/resources ./scalafx-demos/src/test ./scalafx-demos/src/test/scala ./scalafx-demos/src/test/resources

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.

The `project' folder is reserved for Scala SBT.

  1. Credits

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