wiki:Installation

Installation

Installation of VectorGraphics2D is very straight forward: just include the JAR file of the library in your project's class path.

Requirements

Building from source code

The source package contains all files necessary to build VectorGraphics2D from scratch using the Gradle software project management and comprehension tool. Like Makefile files the build.gradle files are used by Gradle to execute certain steps for generating various distribution or documentation files.

First, you have to get VectorGraphics2D's sources from the Download page or from the Subversion repository using the git command:

$ git clone https://github.com/eseifert/vectorgraphics2d.git VectorGraphics2D

Building a JAR file

In case you just want to build the VectorGraphics2D library to get started execute the following command in the VectorGraphics2D source code directory:

$ gradle jar

This will generate a JAR archive named VectorGraphics2D-<version>.jar in the build/libs/ directory. This JAR file can be added to the class path of your application.

Building the distribution archives

In order to build package archives like the ones available for download you have to execute the following command in the package directory:

$ build assemble

This will create a build/libs/ directory containing the following files:

  • VectorGraphics2D-<version>.jar
  • VectorGraphics2D-<version>-javadoc.jar
  • VectorGraphics2D-<version>-sources.jar

Building with ProGuard

To a get a really small and obfuscated build of VectorGraphics2D using ProGuard you need to execute:

$ gradle assemble shrinkJar

Building the documentation

To build the JavaDocs just execute:

$ gradle javadoc

Using VectorGraphics2D in an IDE

The Gradle project can also be used in your favorite development environment like Eclipse or NetBeans. For further information look at the following descriptions on the IDE's websites:

Once you have installed an appropriate Gradle plug-in for your IDE you will be able to import the VectorGraphics2D project found in this folder.

Last modified 2 years ago Last modified on Mar 6, 2016, 10:10:25 PM