Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
allow my use of master during merges of PRs
- fix broken link (#106, #132)
  • Loading branch information
ironsheep committed Apr 24, 2024
1 parent 4951bc9 commit ae26846
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,19 @@ If you are seeing output from the `ifconfig` tool then continue on with the foll

Now that the extra packages are installed let's install our script and any remaining supporting python modules.

**--> NEW!! These instructions adjusted to use the latest released version! See "Why" below.**

```shell
# Get a copy of the repository
sudo git clone https://github.com/ironsheep/RPi-Reporter-MQTT2HA-Daemon.git /opt/RPi-Reporter-MQTT2HA-Daemon

# move into your new local repository
cd /opt/RPi-Reporter-MQTT2HA-Daemon

# (NEW) Move to the latest official release:
sudo git checkout v1.8.5 # (you want to replace v1.8.5 with the latest if this isn't)

# Make sure any script requirement are installed (if they aren't aready)
sudo pip3 install -r requirements.txt
```

Expand All @@ -205,6 +214,10 @@ sudo pip3 install -r requirements.txt

... need to have any mention of `/opt/RPi-Reporter-MQTT2HA-Daemon` changed to your install location **before you can run this script as a service.**

#### Why are we checking-out the latest release?

When I'm developing new features I'll work on a different branch thereby not affecting master. When they are tested I'll merge the development brach into master. However it is much easier to merge pull requests directly into master. This action will, for a short period of time, make the **master branch have possibly non-working code**! You don't want this version until I've completed my testing of the new version and marked it as a new release. The clone gets you all versions while the checkout command moves your installation to the released version so you are running the latest fully tested code. YOu can always check the [releases page](https://github.com/ironsheep/RPi-Reporter-MQTT2HA-Daemon/releases) to find out which is the latest. This also tells you what changes appeared in each release.

## Configuration

To match personal needs, all operational details can be configured by modifying entries within the file [`config.ini`](config.ini.dist).
Expand Down Expand Up @@ -234,7 +247,7 @@ password = {your mqtt password if your setup requires one}
Now that your config.ini is setup let's test!
**NOTE:** *If you wish to support remote commanding of your RPi then you can find additional configuration steps in [Setting up RPi Control from Home Assistant](./RMTCTRL.md) However, to simplifly your effort, please complete the following steps to ensure all is running as desired before you attempt to set up remote control.*
**NOTE:** *If you wish to support remote commanding of your RPi then you can find additional configuration steps in [Setting up RPi Control from Home Assistant](./RMTECTRL.md) However, to simplifly your effort, please complete the following steps to ensure all is running as desired before you attempt to set up remote control.*
## Execution
Expand Down

0 comments on commit ae26846

Please sign in to comment.