From 840f68f1126bfafdfeed2478f07d40a68b4c1cc5 Mon Sep 17 00:00:00 2001 From: Wout Schellaert Date: Wed, 1 Aug 2018 22:55:52 +0200 Subject: [PATCH] Expand and update README --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3275c14..87e6099 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # Blokmap -Een handige map met alle bloklocaties in Gent. -This package uses [demjson](https://deron.meranda.us/python/demjson/download) to check the validity of the json file. +A useful map with al bloklocations (= study locations) in Ghent. +We usually use data from [Stad Gent](https://stad.gent/studenten/studeren/bloklocaties) and mails people send to us. + +## Dev + +You can easily run the site locally by spawning a simple static file server in the `src` directory. For example with `python3 -m http.server` or any other one-liner in [this big list](https://gist.github.com/willurd/5720255). + +This package uses [jsonlint](https://github.com/zaach/jsonlint) to check the validity of the json file. + +Test validity locally by installing the npm package with `npm install -g jsonlint` and then running `jsonlint src/data.json`.