Documentation

Source Repository

GraphStream uses git to manage its sources. If you are not familiar with this revision control system, you could find a tutorial here.

GraphStream is divided into several sub-modules organized as separate repositories. The main ones are :

  • gs-core
  • gs-algo
  • gs-ui-swing
  • gs-ui-javafx
  • gs-ui-android

gs-core is the base of GraphStream which contains graph implementations and file readers and writers. Advances graph related algorithms are located in the gs-algo package. Visualization requires the a ui (user interface) package such as gs-ui-swing gs-ui-javafx or gs-ui-android. These ui packages are named after the technology used to develop them.

Public repositories of GraphStream are hosted on github.

Clone a GraphStream repository

To retrieve sources of GraphStream, you have to clone the corresponding repository. You have to use the following command :

git clone git://github.com/graphstream/gs-xxx.git

where gs-xxx is one of the aforementioned package names.

Git will create a new directory ( named gs-xxx ) and download files of the repository. This cloned repository is in read-only mode, so you can not push changes you will bring on files.

Work with the team on a repository

First you have to be registered on github and to be added as a gs-developer. Then, you have to clone the repository in ssh-mode:

git clone git@github.com:graphstream/gs-core.git

Then you can bring changes to files. To learn how to commit your changes on the repository, you can read the “Making changes” part of the git tutorial.

Other version of this document