Merge pull request #32 from public-transport-quality-grades/BA-257-re…

…adme Ba 257 readme
public-transport-quality-grades · Jun 14, 2018 · 0ad3a47 · 0ad3a47
2 parents 94a2520 + c6f576b
commit 0ad3a47
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,14 @@
-# Public Transport Quality Grades Web App
+# OeVGK18 Web App
 
 [![Build Status](https://travis-ci.org/public-transport-quality-grades/web-app.svg?branch=master)](https://travis-ci.org/public-transport-quality-grades/web-app)
 
+This is the web application for OeVGK18, a method for grading public transport services.
+
+This small React application is used to visualize public transport quality gradings created with the [OevGK18 Generator](https://github.com/public-transport-quality-grades/oevgk18-generator).
+It works in tandem with the [OeVGK18 backend](https://github.com/public-transport-quality-grades/backend).
+
+Head over to the [Docker README](https://github.com/public-transport-quality-grades/web-app/tree/master/docker) for a complete setup to run this application yourself.
+
 ## Credits
 
 Icon &copy; [Arun Thomas](https://www.iconfinder.com/arunxthomas)
diff --git a/docker/README.md b/docker/README.md
@@ -8,6 +8,7 @@ This manual describes how to run the complete web application for public transpo
 * [Docker Compose](https://docs.docker.com/compose/install/)
 * ogr2ogr from [GDAL](http://www.gdal.org/ogr2ogr.html)
 * Public transport quality grades as a set of GeoJSON files generated with [oevgk18-generator](https://github.com/public-transport-quality-grades/oevgk18-generator)
+    * If you want to use existing data, see the release page of [oevgk18-generator](https://github.com/public-transport-quality-grades/oevgk18-generator/releases) to download a precalculated set of public transport quality gradings.
 
 ## Preparation
 
@@ -26,7 +27,9 @@ Oev_Gueteklassen_ARE.geojson Oev_Gueteklassen_ARE.shp -lco RFC7946=YES
 
 ## Setup
 
-1) Copy the result data from the [oevgk18-generator](https://github.com/public-transport-quality-grades/oevgk18-generator) to `generator-results/`. The directory should look something like this:
+1) Copy the result data from the [oevgk18-generator](https://github.com/public-transport-quality-grades/oevgk18-generator) to `generator-results/`.
+
+The directory should look something like this:
 
 ```bash
 $ ll generator-results