Skip to content

Commit

Permalink
Readme restructured.
Browse files Browse the repository at this point in the history
  • Loading branch information
paphko committed Sep 14, 2016
1 parent c9be7d3 commit 6b225ba
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@ Clone this repository:
git clone https://github.com/paphko/mmm-openhabfloorplan.git
````

## Using the module
## Preparing the Floorplan

First of all, you should create an image showing your individual floorplan.
You can use `mmm-openhabfloorplan/images/floorplan-default.png` as template and use an image editor like [paint.net](https://www.getpaint.net/index.html) to change it as you like.
You can use `mmm-openhabfloorplan/images/floorplan-default.png` as template (shown [here](images/README.md)) and use an image editor like [paint.net](https://www.getpaint.net/index.html) to change it as you like.
Save it as `mmm-openhabfloorplan/images/floorplan.png` (leave `floorplan-default.png` untouched).

## Configuring the Module

Now add the module to the modules array in the `config/config.js` file.
Yes, the configuration looks complicated, but there is quite a lot that can be configured.
The in-line comments should explain everything you need to know, so copy this sample configuration and adjust it to your individual openhab server, openhab items, and your floorplan.
Expand Down

0 comments on commit 6b225ba

Please sign in to comment.