diff --git a/README.md b/README.md index 3ec89a3..2cf3ae5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,18 @@ versions are detected ![Sample output](https://djib.fr/djib/PDMameUpdate/raw/branch/master/screenshot.png) +## Installation +You need to rename `config.template.json` to `config.json` and modify it with the proper information. + +You should have Python3 and a few libraries installed (see header in source code). + +If you have `pipenv` installed, then you can do: +```shell +pipenv --three +pipenv install +pipenv run python3 PDMameUpdate.py +``` + ## Usage ```shell usage: PDMameUpdate.py [-h] [-l] [-d] [-c]