Updated readme

master
Mark Qvist 2020-04-30 21:33:37 +02:00
parent 7da169d5d2
commit 202754487d
1 changed files with 27 additions and 2 deletions

View File

@ -1,10 +1,35 @@
OpenModem Configuration Utility
==========
This is the graphical configuration utility for [OpenModem](https://github.com/markqvist/OpenModem). For packaged builds, see the [OpenModem page at unsigned.io](https://unsigned.io/openmodem).
This is the graphical configuration utility for [OpenModem](https://github.com/markqvist/OpenModem).
To download packaged builds, see the [OpenModem page at unsigned.io](https://unsigned.io/openmodem).
Packages are supplied for MacOS, Linux 64-bit and Windows. There is currently no pre-built package for Raspberry Pi, but you can use the instructions below to run it on Raspbian as well.
If you prefer to run from source, it is very easy to do so:
```bash
# If you don't already have Python3, install it:
sudo apt install python3 pip3
# If on a Raspberry Pi, install GTK and webkit dependencies
sudo apt install python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-webkit2-4.0
# Install OpenModem Configuration dependencies
pip3 install pyserial requests psutil pywebview
# Download the program from GitHub
git clone https://github.com/markqvist/openmodemconfigutil.git
# Go to the folder and run the program
cd openmodemconfigutil
python3 openmodemconfigutil.py
```
## Dependencies:
- Python 3
- pyserial
- requests
- psutil
- pywebview
- pywebview