From 0b6d2f4164b9d823fb2a49d9fb4e83242f695e09 Mon Sep 17 00:00:00 2001 From: Jacek Kowalski <Jacek@jacekk.info> Date: Sun, 30 Jun 2019 21:59:01 +0000 Subject: [PATCH] Update README - include requirements and info on running composer --- README.md | 22 ++++++++++++++++++++-- 1 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fb7e2ef..7cbce0e 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,23 @@ ## Usage -To gather vehicle to ID mapping run `parse.php`. -Files `mapping_A.json` and `mapping_T.json` are put in `data` directory. +Install dependencies by running: +``` +composer update +``` + +To gather vehicle to ID mappings just run: +``` +php parse.php +``` + +Output files `mapping_A.json` and `mapping_T.json` are put in `data` directory. + +## Requirements + +- [Composer](https://getcomposer.org/), +- PHP 7.0+, +- [PHP ftp extension](https://www.php.net/manual/en/ftp.installation.php), +- [PHP json extension](https://www.php.net/manual/en/json.installation.php), +- [PHP PDO extension](https://www.php.net/manual/en/pdo.installation.php), +- [PHP PDO SQLite extension](https://www.php.net/manual/en/ref.pdo-sqlite.php). -- Gitblit v1.9.1