Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
interkosmos committed Sep 5, 2017
1 parent 3886b1e commit 2f682c3
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,23 @@ The current development version of OpenADMS is 0.5 (code name
more information, please see https://www.dabamos.de/.

## Installation
To run OpenADMS, clone the master branch, install the dependencies and execute
`openadms.py`:

Before you can start OpenADMS, you have to clone the master branch and install
all dependencies:
```
$ git clone https://github.com/dabamos/openadms.git
$ cd openadms
$ python3 -m pip install -U -r requirements.txt
$ python3 openadms.py --config ./config/myconfig.json --with-mqtt-broker --debug
```
Run OpenADMS from the command line:
```
$ python3 openadms.py --config ./config/my_config.json --with-mqtt-broker --debug
```
OpenADMS also features a graphical launcher. At first, run `win_install.bat` on
Microsoft Windows or install the dependencies manually:
```
$ python3 -m pip install Gooey
```
Execute `openadms-gui.pyw` to start the graphical launcher.

### Dependencies
OpenADMS depends on the following Python libraries:
Expand Down Expand Up @@ -64,15 +72,13 @@ The configuration of OpenADMS is done by using a JSON-based text file, located
in the directory `./config`. Please define modules, serial ports, sensors, and
so on there. OpenADMS takes the file name of your custom configuration as an
argument. For instance, run:

```
$ python3 openadms.py --config ./config/myconfig.json --with-mqtt-broker --debug
```

## Virtual Environment
The Python tool `venv` can create a virtual Python environment for development
(with `csh`/`tcsh` on Unix):

```
$ python3 -m venv virtual-environment
$ source ./virtual-environment/bin/activate.csh
Expand All @@ -89,4 +95,3 @@ the project website.
## Licence
OpenADMS is licenced under the [European Union Public
Licence](https://joinup.ec.europa.eu/community/eupl/og_page/eupl) (EUPL) v1.1.

0 comments on commit 2f682c3

Please sign in to comment.