From 1a6e2a482a404ad97c600ed9048da0688b76f959 Mon Sep 17 00:00:00 2001 From: oblonski Date: Thu, 1 Sep 2016 08:44:11 +0200 Subject: [PATCH] create and add docs --- docs/Home.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/Home.md diff --git a/docs/Home.md b/docs/Home.md new file mode 100644 index 00000000..de79687e --- /dev/null +++ b/docs/Home.md @@ -0,0 +1,48 @@ +##[Whats New](https://github.com/jsprit/jsprit/blob/master/WHATS_NEW.md) + +## [Get Started](https://github.com/jsprit/jsprit/wiki/Getting-Started) + +Setting up jsprit and the like. + +## Examples + +* [Simple Example](https://github.com/jsprit/jsprit/wiki/Simple-Example) +* [More Examples](https://github.com/jsprit/jsprit/wiki/More-Examples) + +## [Meta-Heuristic](https://github.com/jsprit/jsprit/wiki/Meta-Heuristic) + +Gives a basic description of the applied meta-heuristic. + +## Modules and Dependencies + +Please read [Notice.md](https://github.com/graphhopper/jsprit/blob/master/NOTICE.md) to get to know the direct dependencies of each module. + +## Building the latest jsprit master + +``` +git clone https://github.com/graphhopper/jsprit.git +cd jsprit +mvn clean install +``` + + +## Contributions + +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) + +Sponsors/Acknowledgement/Testimonials + +##Contact + +####Mailing List: +In the [forum](https://discuss.graphhopper.com/) you can discuss jsprit related issues and you will probably get answers to your questions. + +####Issue Tracker: +For bugs, feature requests or similar use the [issue tracker](https://github.com/jsprit/jsprit/issues). + +####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: + +info@graphhopper.com \ No newline at end of file