1
0
Fork 0
mirror of https://github.com/graphhopper/jsprit.git synced 2020-01-24 07:45:05 +01:00

create and add docs

This commit is contained in:
oblonski 2016-09-01 10:02:37 +02:00
parent cf9a90e498
commit 5a5bcccd94

View file

@ -10,7 +10,7 @@ jsprit is a multi-module project and consists of:
- jsprit-io - jsprit-io
####Maven way ####Maven way
To use jsprit-core, add the following lines to your pom: If you want to use the latest release of jsprit-core, add the following lines to your pom:
<pre><code>&lt;dependency&gt; <pre><code>&lt;dependency&gt;
&lt;groupId&gt;com.graphhopper&lt;/groupId&gt; &lt;groupId&gt;com.graphhopper&lt;/groupId&gt;
@ -19,6 +19,15 @@ To use jsprit-core, add the following lines to your pom:
&lt;/dependency&gt; &lt;/dependency&gt;
</code></pre> </code></pre>
####Build yourself
If you want to build the master branch yourself, do this:
```
git clone https://github.com/graphhopper/jsprit.git
cd jsprit
mvn clean install
```
####If you do not have an IDE and you want to use Maven ####If you do not have an IDE and you want to use Maven
the following documentation is recommended: the following documentation is recommended:
@ -28,9 +37,7 @@ the following documentation is recommended:
Here you learn to setup the Java environment and an Integrated Development Environment (IDE). In the subsection <em>Adding Jars to your Project</em> 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. Here you learn to setup the Java environment and an Integrated Development Environment (IDE). In the subsection <em>Adding Jars to your Project</em> 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 #### 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. to manage your dependencies, go to [maven central](https://search.maven.org/), search for jsprit and download the latest binaries to put them into your classpath.
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.