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 12:20:35 +02:00
parent 5cae8ab514
commit c61d8b0632
2 changed files with 13 additions and 13 deletions

View file

@ -1,5 +1,5 @@
####Requirements ####Requirements
jsprit requires the Java 2 platform (JDK version 1.6.0 or later). jsprit requires the Java 2 platform (JDK version 1.6.0 or later).
####Modules ####Modules
jsprit is a multi-module project and consists of: jsprit is a multi-module project and consists of:
@ -44,9 +44,9 @@ For example, if you want to use the release v1.0.0 of jsprit-core, add:
</dependency> </dependency>
</code></pre> </code></pre>
[Add the latest snapshot to your pom](https://github.com/jsprit/jsprit/wiki/Add-latest-snapshot-to-your-pom). [Add the latest snapshot to your pom](Add-latest-snapshot-to-your-pom.md).
[Add the latest release to your pom](https://github.com/jsprit/jsprit/wiki/Add-latest-release-to-your-pom). [Add the latest release to your pom](Add-latest-release-to-your-pom.md).
####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
@ -59,7 +59,7 @@ Here you learn to setup the Java environment and an Integrated Development Envir
#### 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 [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. Go ahead and show me a [simple example](Simple-Example.md) of how to setup and solve a vehicle routing problem.

View file

@ -1,15 +1,15 @@
##[Whats New](https://github.com/jsprit/jsprit/blob/master/WHATS_NEW.md) ##[Whats New](https://github.com/jsprit/jsprit/blob/master/WHATS_NEW.md)
## [Get Started](https://github.com/jsprit/jsprit/wiki/Getting-Started) ## [Get Started](Getting-Started.md)
Setting up jsprit and the like. Setting up jsprit and the like.
## Examples ## Examples
* [Simple Example](https://github.com/jsprit/jsprit/wiki/Simple-Example) * [Simple Example](Simple-Example.md)
* [More Examples](https://github.com/jsprit/jsprit/wiki/More-Examples) * [More Examples](More-Examples.md)
## [Meta-Heuristic](https://github.com/jsprit/jsprit/wiki/Meta-Heuristic) ## [Meta-Heuristic](Meta-Heuristic.md)
Gives a basic description of the applied meta-heuristic. Gives a basic description of the applied meta-heuristic.
@ -30,19 +30,19 @@ mvn clean install
If you want to contribute to jsprit (which would be great), fork the project and build your fork, make changes, run your and jsprit's test cases and make a pull request (see [help.github.contribute](https://help.github.com/articles/fork-a-repo) or [stackoverflow.contribute](http://stackoverflow.com/questions/4384776/how-do-i-contribute-to-others-code-in-github) for details). If you want to contribute to jsprit (which would be great), fork the project and build your fork, make changes, run your and jsprit's test cases and make a pull request (see [help.github.contribute](https://help.github.com/articles/fork-a-repo) or [stackoverflow.contribute](http://stackoverflow.com/questions/4384776/how-do-i-contribute-to-others-code-in-github) for details).
## [Acknowledgement](https://github.com/jsprit/jsprit/wiki/Acknowledgement) ## [Acknowledgement](Acknowledgement.md)
Sponsors/Acknowledgement/Testimonials Sponsors/Acknowledgement/Testimonials
##Contact ##Contact
####Mailing List: ####Mailing List:
In the [forum](https://discuss.graphhopper.com/) you can discuss jsprit related issues and you will probably get answers to your questions. In the [forum](https://discuss.graphhopper.com/) you can discuss jsprit related issues and you will probably get answers to your questions.
####Issue Tracker: ####Issue Tracker:
For bugs, feature requests or similar use the [issue tracker](https://github.com/jsprit/jsprit/issues). For bugs, feature requests or similar use the [issue tracker](https://github.com/jsprit/jsprit/issues).
####Email: ####Email:
If you cannot get help in the mailing list or you just do not want to discuss your topic publicly, send an email to: If you cannot get help in the mailing list or you just do not want to discuss your topic publicly, send an email to:
info@graphhopper.com info@graphhopper.com