From 0ba2ebb91d5bbb1275193529dbf6246c6f0364de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yoann=20Pign=C3=A9?= Date: Thu, 12 Apr 2018 10:50:59 +0200 Subject: [PATCH] install docs + dependencies --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++------------ pom.xml | 72 +++++++++++++------------------------------------- 2 files changed, 80 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index b1b0ca8..74eed55 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,77 @@ -GraphStream -=========== +# GraphStream -- JavaFX Viewer -The GraphStream project is java library that provides a API to model, -analyze and visualize graphs and dynamic graphs. +[![Build Status](https://travis-ci.org/graphstream/gs-ui-javafx.svg?branch=master)](https://travis-ci.org/graphstream/gs-ui-javafx) -Check out the Website (http://www.graphstream-project.org/) for more information. +The GraphStream project is a java library that provides an API to model, analyze and visualize graphs and dynamic graphs. -UI --- +This module contains a JavaFX implementation of the GraphStream Viewer. -This module provides a JavaFX implementation of the GraphStream Viewer. +Check out the Website for more information. + +## UI + +This viewer is a rewrite of the old [gs-ui](https://github.com/graphstream/gs-ui) [Scala](http://www.scala-lang.org/)-based renderer. `gs-ui` is now deprecated. This renderer supports almost all of the CSS properties defined in the [GraphStream CSS Reference](http://graphstream-project.org/doc/Tutorials/GraphStream-CSS-Reference_1.0/), however it is still a work in progress. This viewer is intended only at 2D visualization actually. We are interested in any suggestion to improve this renderer, and your use cases could be of great help for us in developing this project. If you like and use this project, this could be a good contribution. -Building and jars ------------------ -The project need gs-core for compile. -The release comes with a pre-packaged jar file named gs-ui-javafx.jar that contains the GraphStream classes related to this UI. To start using GraphStream, simply put this jar file and the gs-core.jar in your class path. +## Install UI + +`gs-ui-javafx` is a plugin to the `gs-core` main project. + +The release comes with a pre-packaged jar file named `gs-ui-javafx.jar` that contains the GraphStream viewer classes. It depends on the root project `gs-core`. To start using GraphStream with a viewer, simply put `gs-core.jar` and `gs-ui-javafx.jar` in your class path. You can download GraphStream on the github releases pages: + +- [gs-core](https://github.com/graphstream/gs-core/releases) +- [gs-ui-javafx](https://github.com/graphstream/gs-ui-javafx/releases) + +Maven users, you may include `gs-core` and `gs-ui-javafx` as a dependency to your project using . +Simply add the `jitpack` repository to the `pom.xml`: + +```xml + + + jitpack.io + https://jitpack.io + + +``` + +then, add the `gs-core` and `gs-ui-javafx` to your dependencies: + +```xml + + com.github.graphstream + gs-core + dev-SNAPSHOT + + + com.github.graphstream + gs-ui-javafx + dev-SNAPSHOT + +``` + +You can use any version of `gs-core` and `gs-ui-javafx` you need, provided they are the same. Simply specify the desired version in the `` tag. The version can be a git tag name (e.g. `2.0-alpha`), a commit number, or a branch name followed by `-SNAPSHOT` (e.g. `dev-SNAPSHOT`). More details on the [possible versions on jitpack](https://jitpack.io/#graphstream/gs-core). + +## Configure UI + +Finally, `gs-core` needs to be told which UI implementation to use. Simply add a system property to you project: + +```java +System.setProperty("org.graphstream.ui", "javafx"); +``` + +Or use the command line : + +```bash +java -Dorg.graphstream.ui=javafx YourClass +``` -Help ----- +## Help You may check the documentation on the [website](http://graphstream-project.org). You may also share your questions on the mailing list at http://sympa.litislab.fr/sympa/subscribe/graphstream-users -License -------- +## License See the COPYING file. \ No newline at end of file diff --git a/pom.xml b/pom.xml index c0c6c85..508aba6 100644 --- a/pom.xml +++ b/pom.xml @@ -18,18 +18,13 @@ 4.0.0 - - - org.sonatype.oss - oss-parent - 7 - org.graphstream gs-ui-javafx 0.0.1-SNAPSHOT + gs-ui-javafx - JavaFX interface for GraphStream + javafx interface for GraphStream http://graphstream-project.org @@ -65,36 +60,17 @@ - - nodeps - - - - ../gs-deps/mbox2/target/classes - - org/**/*.class - - - - ../gs-deps/pherd/target/classes - - org/**/*.class - - - - - - - + release org.apache.maven.plugins maven-gpg-plugin + 1.6 ]]> false @@ -113,7 +89,7 @@ - + src bin @@ -143,24 +119,7 @@ 1.8 1.8 - 3.6.2 - - - - maven-eclipse-plugin - org.apache.maven.plugins - - - ** - - - 2.9 - - - - org.apache.maven.plugins - maven-jar-plugin - 3.0.0 + 3.7.0 @@ -180,6 +139,7 @@ true + flase false false false @@ -192,7 +152,7 @@ true The GraphStream ${project.version} API - 3.0.0-M1 + 3.0.0 org.apache.maven.plugins @@ -267,8 +227,10 @@ com.github.graphstream gs-core - 2.0-alpha + dev-SNAPSHOT + provided + junit junit @@ -276,11 +238,13 @@ false test + - org.graphstream + com.github.graphstream gs-algo - 2.0.0-SNAPSHOT + dev-SNAPSHOT test + \ No newline at end of file