Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Commit

Permalink
add instruction to run/build from source into readme
Browse files Browse the repository at this point in the history
  • Loading branch information
baskiton committed Aug 13, 2023
1 parent 3af8208 commit 17858c4
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 17858c4

Please sign in to comment.