Skip to content

Commit 32aa164

Browse files
author
jsroyal
committed
fixed broken link and correct syntax with md
1 parent 29fbdd6 commit 32aa164

File tree

5 files changed

+56
-14
lines changed

5 files changed

+56
-14
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ jsprit
22
======
33
[![Build Status](https://travis-ci.org/graphhopper/jsprit.svg?branch=master)](https://travis-ci.org/graphhopper/jsprit)
44

5-
jsprit is a java based, open source toolkit for solving rich <a href="http://en.wikipedia.org/wiki/Travelling_salesman_problem" target="_blank">traveling salesman</a> (TSP) and <a href="http://neo.lcc.uma.es/vrp/vehicle-routing-problem/" target="_blank">vehicle routing problems</a> (VRP).
6-
It is lightweight, flexible and easy-to-use, and based on a single all-purpose <a href="https://github.com/jsprit/jsprit/wiki/Meta-Heuristic" target="_blank">meta-heuristic</a> currently solving
5+
jsprit is a java based, open source toolkit for solving rich [Traveling Salesman Problems(TSP)](http://en.wikipedia.org/wiki/Travelling_salesman_problem") and [Vehicle Routing Problems(VRP)](http://neo.lcc.uma.es/vrp/vehicle-routing-problem/).
6+
It is lightweight, flexible and easy-to-use, and based on a single all-purpose [meta-heuristic](../docs/Meta-Heuristic.md) currently solving
77
- Capacitated VRP
88
- Multiple Depot VRP
99
- VRP with Time Windows
@@ -16,10 +16,10 @@ It is lightweight, flexible and easy-to-use, and based on a single all-purpose <
1616
- Various combination of these types
1717

1818
Setting up the problem, defining additional constraints, modifying the algorithms and visualising the discovered solutions is as easy and handy as
19-
reading classical VRP instances to benchmark your algorithm. It is fit for change and extension due to a modular design and a comprehensive set of unit and integration-tests. [More features ...](https://github.com/jsprit/jsprit/wiki/features)
19+
reading classical VRP instances to benchmark your algorithm. It is fit for change and extension due to a modular design and a comprehensive set of unit and integration-tests. [More features ...](../docs/Features.textile)
2020

21-
## Getting Started and Documentation
22-
Please visit [docs](https://github.com/graphhopper/jsprit/blob/master/docs/Home.md) to learn more. For older versions (<v1.7) use [old-docs](https://github.com/graphhopper/jsprit/blob/%3C1.7/docs/Home.md). The best way to get to know jsprit is by looking at [code examples](https://github.com/graphhopper/jsprit/tree/master/jsprit-examples/src/main/java/com/graphhopper/jsprit/examples).
21+
## Getting Started with Documentation
22+
Please visit [docs](https://github.com/graphhopper/jsprit/blob/master/docs/Home.md) to learn more.The best way to get to know jsprit is by looking at [code examples](https://github.com/graphhopper/jsprit/tree/master/jsprit-examples/src/main/java/com/graphhopper/jsprit/examples).
2323

2424
## Modules and Dependencies
2525
Please read [Notice.md](https://github.com/graphhopper/jsprit/blob/master/NOTICE.md) to get to know the direct dependencies of each module.
@@ -42,7 +42,7 @@ Developing this would be much more difficult without the help of [these companie
4242
## Contact
4343

4444
#### Mailing List:
45-
In the [mailing list](https://discuss.graphhopper.com/) ([old mailing list](https://groups.google.com/group/jsprit-mailing-list)) you can discuss jsprit related issues and you will probably get answers to your questions.
45+
In the [Graphhopper Forum ](https://discuss.graphhopper.com/) ([Also you can see the old mailing list](https://groups.google.com/group/jsprit-mailing-list)) you can discuss jsprit related issues and you will probably get answers to your questions.
4646

4747
#### Stackoverflow:
4848
You can also use [stackoverflow](http://stackoverflow.com/questions/tagged/jsprit) to discuss your issues. Tag it with <em>jsprit</em> then it is easier to keep track of your topic.
@@ -51,7 +51,7 @@ You can also use [stackoverflow](http://stackoverflow.com/questions/tagged/jspri
5151
For bugs, feature requests or similar use the [issue tracker](https://github.com/jsprit/jsprit/issues).
5252

5353
#### Email:
54-
If you cannot get help in the mailing list or you just do not want to discuss your topic publicly, contact us via https://graphhopper.com/#contact
54+
If you cannot get help in the mailing list or you just do not want to discuss your topic publicly, [contact us via mail](https://graphhopper.com/#contact)
5555

5656

5757
## About

docs/Dial-a-ride-problem.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
You model a dial-a-ride problem much like a vehicle routing problem with pickups and deliveries. The capacity of vehicles can be interpreted as number of seats available. A shipment is here understood as a ride from one location to another (probably you want the shipment to have a capacity-demand of 1). See [VRP with pickups and deliveries](https://github.com/jsprit/jsprit/wiki/VRP-with-pickups-and-deliveries).
1+
You model a dial-a-ride problem much like a vehicle routing problem with pickups and deliveries. The capacity of vehicles can be interpreted as number of seats available. A shipment is here understood as a ride from one location to another (probably you want the shipment to have a capacity-demand of 1). See [VRP with pickups and deliveries](../docs/Vrp-with-pickups-and-deliveries.md).

docs/Getting-Started.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
####Requirements
1+
#### Requirements
22
jsprit requires Java 1.7.0 or later.
33

4-
####Modules
4+
#### Modules
55
jsprit is a multi-module project and consists of:
66
- jsprit-core
77
- jsprit-analysis
88
- jsprit-instances
99
- jsprit-examples
1010
- jsprit-io
1111

12-
####Maven way
12+
#### Maven way
1313
If you want to use the latest release of jsprit-core, add the following lines to your pom:
1414

1515
<pre><code>&lt;dependency&gt;
@@ -21,7 +21,7 @@ If you want to use the latest release of jsprit-core, add the following lines to
2121

2222
Find the latest versions here: [mvn repository](https://mvnrepository.com/artifact/com.graphhopper/jsprit-core).
2323

24-
####Build yourself
24+
#### Build yourself
2525
If you want to build the master branch yourself, do this:
2626

2727
```
@@ -30,7 +30,7 @@ cd jsprit
3030
mvn clean install
3131
```
3232

33-
####If you do not have an IDE and you want to use Maven
33+
#### If you do not have an IDE and you want to use Maven
3434

3535
the following documentation is recommended:
3636

@@ -39,6 +39,7 @@ the following documentation is recommended:
3939
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.
4040

4141
#### If you do not want Maven
42+
4243
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.
4344

4445
Go ahead and show me a [simple example](Simple-Example.md) of how to setup and solve a vehicle routing problem.

docs/VRP-with-time-windows-example.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ Collection<VehicleRoutingProblemSolution> solutions = algorithm.searchSolutions(
108108
VehicleRoutingProblemSolution bestSolution = Solutions.bestOf(solutions);
109109
</code></pre>
110110

111-
Please visit <a href="https://github.com/jsprit/jsprit/wiki/Simple-Example">Simple Example</a> to get to know how you can analyse the solution.
111+
Please visit [Simple Example](Simple-Example.md) to get to know how you can analyse the solution.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<problem xmlns="http://www.w3schools.com"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.w3schools.com vrp_xml_schema.xsd">
4+
<problemType>
5+
<fleetSize>INFINITE</fleetSize>
6+
</problemType>
7+
<shipments>
8+
<shipment id="1">
9+
<pickup>
10+
<location>
11+
<id>[x=1.0][y=2.0]</id>
12+
<coord x="1.0" y="2.0"/>
13+
</location>
14+
<duration>100.0</duration>
15+
<timeWindows>
16+
<timeWindow>
17+
<start>1.0</start>
18+
<end>2.0</end>
19+
</timeWindow>
20+
</timeWindows>
21+
</pickup>
22+
<delivery>
23+
<location>
24+
<id>delLoc</id>
25+
<coord x="5.0" y="6.0"/>
26+
</location>
27+
<duration>50.0</duration>
28+
<timeWindows>
29+
<timeWindow>
30+
<start>3.0</start>
31+
<end>4.0</end>
32+
</timeWindow>
33+
</timeWindows>
34+
</delivery>
35+
<capacity-dimensions>
36+
<dimension index="0">10</dimension>
37+
</capacity-dimensions>
38+
<requiredSkills>skill3, skill1, skill2</requiredSkills>
39+
</shipment>
40+
</shipments>
41+
</problem>

0 commit comments

Comments
 (0)