Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
laidig authored Sep 10, 2016
1 parent e6df59f commit 90fc992
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,28 @@ gtfs-validator

A Java framework for GTFS validation and statistics.

[![Build Status](https://travis-ci.org/laidig/gtfs-validator.svg?branch=master)](https://travis-ci.org/laidig/gtfs-validator) [![Coverage Status](https://coveralls.io/repos/github/laidig/gtfs-validator/badge.svg?branch=master)](https://coveralls.io/github/laidig/gtfs-validator?branch=master)
[![Build Status](https://travis-ci.org/laidig/gtfs-validator.svg?branch=master)](https://travis-ci.org/laidig/gtfs-validator)

How is this different than the Google-supported validator?
=============
The Google TransitFeed-based [validator](https://github.com/google/transitfeed/blob/master/feedvalidator.py) is written in Python, and is quite slow on large feeds. I also find the code rather hard to understand. While it supports extensions, few have extended it.

This validator uses the [Onebusaway-GTFS](https://github.com/OneBusAway/onebusaway-gtfs-modules) library, written in Java and is far faster at processing large feeds.

How is this different than Conveyal's branch?
=============
This project originated at Conveyal. This fork includes a number of updates and improvements, namely:
* Requiring Java 8
* Updated dependencies to currently supported versions
* Minor bug fixes and light refactoring
* More testing
* Continuous Integration via Travis, and
* A number of additional validations

Using this framework
==============
Check out this repository and import using Maven.

There are then multiple options for use:


1. Use the JAR provided in the releases. `java -jar gtfs-validator.jar yourGtfs.zip`

2. Import the services provided and build your own validation.
Expand All @@ -21,7 +34,7 @@ There are then multiple options for use:
==============
ValidatorMain

The ValidatorMain class logs a number of common GTFS errors to Standard Out on the console. This includes:
The ValidatorMain class logs a number of common GTFS errors to Standard Out on the console when run as a JAR. This includes:

* Problems with route names
* Bad shape coordinates
Expand All @@ -30,7 +43,7 @@ The ValidatorMain class logs a number of common GTFS errors to Standard Out on t
* Missing stop coordinates
* Missing stop times for trips
* Stop times out of sequence
* Duplicated trips in trips.txt
* Duplicated trips (same times)
* Overlapping trips when block_id is present
* Missing shapes and shape coordinates
* “Reversed” shapes with directions that do not agree with stop times.
Expand Down

0 comments on commit 90fc992

Please sign in to comment.