Skip to content

Commit b3b2815

Browse files
authored
Merge pull request eschava#70 from digitlength/patch-1
Update README.md
2 parents 0e2d3d0 + 11a8672 commit b3b2815

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,22 @@
1313
Clone *broadlink-mqtt* repository using
1414
`git clone https://github.com/eschava/broadlink-mqtt.git`
1515
or download and unpack latest archive from
16-
https://github.com/eschava/broadlink-mqtt/archive/master.zip
16+
https://github.com/eschava/broadlink-mqtt/archive/master.zip
1717

18-
Also need to install required Python modules using
19-
`pip install -r requirements.txt`
18+
Ensure that a python development environment is setup:
19+
`sudo apt-get install python-pip python-dev`
20+
21+
Ensure that the *libffi-dev* and *libssl-dev* packages are installed:
22+
`sudo apt-get install libffi-dev libssl-dev`
23+
24+
From the newly created *broadlink-mqtt* folder, install the required Python modules:
25+
`pip install -r requirements.txt`
2026

2127
## Configuration
22-
All configurable parameters are present in `mqtt.conf` file. But there is also `custom.conf` file. Changes from `custom.conf` overrides `mqtt.conf` and it's better to put changed configuration parameters there, to avoid conflicts while updating branch from repository.
28+
By default, *broadlink-mqtt* will configure using parameters from `mqtt.conf`. This configuration file may be altered during a repository update, so another configuration file is provided for editing: `custom.conf`
29+
30+
`custom.conf` overrides `mqtt.conf`. Copy the contents of `mqtt.conf` into `custom.conf` and continue editing only `custom.conf`.
31+
2332
Recorded commands are saved under the `commands/` folder
2433
Macros are saved under the `macros/` folder
2534

0 commit comments

Comments
 (0)