From 17858c4a51558ef5a7380ecefc29e2eb401b63d2 Mon Sep 17 00:00:00 2001 From: baskiton Date: Sun, 13 Aug 2023 21:17:55 +0700 Subject: [PATCH] add instruction to run/build from source into readme --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d2e56b9..8afaa1e 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,33 @@ and wait for result. #### Hotkeys * `Ctrl-Q` Quit -* `F1` Show About window - +* `F1` Show About window, check if newer version available ![](doc/Screenshot.jpg) + + +### Run from source +Required at least Python 3.7 +I recommend to use a virtual environment + +Install required packages: +```commandline +pip install -r requirements.txt +``` + +To run: +```commandline +python -m GeoscanDecoder --ui +``` + + +### Build from source +Required at least Python 3.7 +I recommend to use a virtual environment + +```commandline +pip install -r requirements.txt +pip install pyinstaller +pyinstaller -y decoder.spec +``` +The result build can be found in the `dist` folder