From 90fc9927bd6a49ed939ab48fd1be8eb82cbf5142 Mon Sep 17 00:00:00 2001 From: Tony Laidig Date: Fri, 9 Sep 2016 22:41:58 -0400 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 937a0b2..a963d88 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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.