From 249f1acdb3ef08b183a9db396d0a025121e978ee Mon Sep 17 00:00:00 2001 From: oblonski Date: Thu, 1 Sep 2016 09:55:06 +0200 Subject: [PATCH] create and add docs --- docs/Getting-Started.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/Getting-Started.md diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md new file mode 100644 index 00000000..bebc4157 --- /dev/null +++ b/docs/Getting-Started.md @@ -0,0 +1,39 @@ +####Requirements +jsprit requires the Java 2 platform (JDK version 1.7.0 or later). + +####Modules +jsprit is a multi-module project and consists of: +- jsprit-core +- jsprit-analysis +- jsprit-instances +- jsprit-examples +- jsprit-io + +####Maven way +To use jsprit-core, add the following lines to your pom: + +
<dependency>
+   <groupId>com.graphhopper</groupId>
+   <artifactId>jsprit-core</artifactId>
+   <version>1.7-RC1</version>
+</dependency>
+
+ +####If you do not have an IDE and you want to use Maven + +the following documentation is recommended: + +GeoTools - Quickstart + +Here you learn to setup the Java environment and an Integrated Development Environment (IDE). In the subsection Adding Jars to your Project you learn to integrate external libraries in your project. Just copy/paste the above jsprit releases/snapshots to your pom.xml instead of the GeoTools-artifacts. + +#### If you do not want Maven +to manage your dependencies, go to [snapshot-jars](https://github.com/jsprit/mvn-rep/tree/master/snapshots/jsprit) or [release-jars](https://github.com/jsprit/mvn-rep/tree/master/releases/jsprit) to download jsprit-binaries directly. Just click on the jar-file you want to download and use the 'Raw'-button to actually download it. Put the jars into your classpath. Note that you then need to put all [dependencies](https://github.com/jsprit/jsprit/wiki/Modules-and-Dependencies) jsprit relies on manually to your classpath as well. + +Go ahead and show me a [simple example](https://github.com/jsprit/jsprit/wiki/Simple-Example) of how to setup and solve a vehicle routing problem. + + + + + +