Expand and update README
This commit is contained in:
parent
4e20d203da
commit
840f68f112
1 changed files with 10 additions and 2 deletions
12
README.md
12
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`.
|
||||
|
|
Loading…
Reference in a new issue