Skip to content

Commit

Permalink
install docs + dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
@pigne
pigne committed Apr 12, 2018
1 parent 373af85 commit 0ba2ebb
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 70 deletions.
78 changes: 62 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -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 <http://www.graphstream-project.org/> 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 <https://jitpack.io>.
Simply add the `jitpack` repository to the `pom.xml`:

```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
```

then, add the `gs-core` and `gs-ui-javafx` to your dependencies:

```xml
<dependency>
<groupId>com.github.graphstream</groupId>
<artifactId>gs-core</artifactId>
<version>dev-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.github.graphstream</groupId>
<artifactId>gs-ui-javafx</artifactId>
<version>dev-SNAPSHOT</version>
</dependency>
```

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 `<version>` 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.
72 changes: 18 additions & 54 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,13 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.sonatype.oss</groupId>
<artifactId>oss-parent</artifactId>
<version>7</version>
</parent>

<groupId>org.graphstream</groupId>
<artifactId>gs-ui-javafx</artifactId>
<version>0.0.1-SNAPSHOT</version>

<name>gs-ui-javafx</name>
<description>JavaFX interface for GraphStream</description>
<description>javafx interface for GraphStream</description>

<url>http://graphstream-project.org</url>

Expand Down Expand Up @@ -65,36 +60,17 @@

<profiles>
<profile>
<!-- This profile includes classes of mbox2 and pherd project to create
a fully usable jar. You need to have a valid gs-deps folder at the same hierarchic
level that the one of your project with mbox2 and pherd compiled (mvn compile). -->
<id>nodeps</id>
<build>
<resources>
<resource>
<directory>../gs-deps/mbox2/target/classes</directory>
<includes>
<include>org/**/*.class</include>
</includes>
</resource>
<resource>
<directory>../gs-deps/pherd/target/classes</directory>
<includes>
<include>org/**/*.class</include>
</includes>
</resource>
</resources>
</build>
</profile>
<profile>
<!-- This profile has to be enabled when releasing the package. It will
enable the sign phase. -->
<!--
This profile has to be enabled when releasing the package. It will
enable the sign phase.
-->
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<configuration>
<keyname><![CDATA[GraphStream Team <[email protected]>]]></keyname>
<skip>false</skip>
Expand All @@ -113,7 +89,7 @@
</build>
</profile>
</profiles>

<build>
<sourceDirectory>src</sourceDirectory>
<outputDirectory>bin</outputDirectory>
Expand Down Expand Up @@ -143,24 +119,7 @@
<source>1.8</source>
<target>1.8</target>
</configuration>
<version>3.6.2</version>
</plugin>

<plugin>
<artifactId>maven-eclipse-plugin</artifactId>
<groupId>org.apache.maven.plugins</groupId>
<configuration>
<sourceIncludes>
<include>**</include>
</sourceIncludes>
</configuration>
<version>2.9</version>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.0.0</version>
<version>3.7.0</version>
</plugin>

<plugin>
Expand All @@ -180,6 +139,7 @@
</tag>
</tags>
<author>true</author>
<failOnError>flase</failOnError>
<nodeprecated>false</nodeprecated>
<nodeprecatedlist>false</nodeprecatedlist>
<noindex>false</noindex>
Expand All @@ -192,7 +152,7 @@
<version>true</version>
<windowtitle>The GraphStream ${project.version} API</windowtitle>
</configuration>
<version>3.0.0-M1</version>
<version>3.0.0</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down Expand Up @@ -267,20 +227,24 @@
<dependency>
<groupId>com.github.graphstream</groupId>
<artifactId>gs-core</artifactId>
<version>2.0-alpha</version>
<version>dev-SNAPSHOT</version>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<optional>false</optional>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.graphstream</groupId>
<groupId>com.github.graphstream</groupId>
<artifactId>gs-algo</artifactId>
<version>2.0.0-SNAPSHOT</version>
<version>dev-SNAPSHOT</version>
<scope>test</scope>
</dependency>

</dependencies>
</project>

0 comments on commit 0ba2ebb

Please sign in to comment.