Skip to content

Commit

Permalink
* Updated Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
jperedadnr committed May 6, 2015
1 parent 3609d3d commit 64cc9fb
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,42 @@ JavaFX 3D Visualization and Component Library

F(X)yz is a new JavaFX 3D library that provides additional primitives, composite objects, controls and data
visualizations that the base JavaFX 8 3D packages do not have.

Building FXyz
====================

You will need [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
and [ANT](http://ant.apache.org/) installed to build the project.

Add the included jars as local dependencies to the project:

- JCSG.jar
- poly2tri.jar

Running FXyz
===================

After you've built the project you can run this with a simple java command.

```bash
java -jar dist/FXyzLib.jar
```

You can select between the multiple tests available under org.fxyz.tests:

```bash
java -cp .;dist/FXyzLib.jar org.fxyz.tests.Text3DTest
```

Sampler
===================

For a visual application to run all the tests and their multiple options, you can
try our [Sampler](https://github.com/FXyz/FXyz).

License
===================

The project is licensed under GPL 3. See [LICENSE](https://github.com/Birdasaur/FXyz/blob/master/LICENSE)
file for the full license.

0 comments on commit 64cc9fb

Please sign in to comment.