Skip to content

Commit d9bd60f

Browse files
committed
add updating instructions to readme (#30)
1 parent 62b4017 commit d9bd60f

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -76,18 +76,11 @@ This API is used by the web interface, but can also be used by other programs to
7676

7777
## Installation
7878

79-
For all installation methods, you must first install Python 3. After doing so, run `pip3 install -r requirements.txt` to
80-
install the required libraries.
81-
82-
### Manual
83-
84-
Clone or download this repository onto the Raspberry Pi.
85-
86-
### Systemd
87-
88-
1. Clone or download this repository onto the Raspberry Pi.
89-
2. Create the following `matrixdisplay.service` file in `/etc/systemd/system/`, making sure to change
90-
the `WorkingDirectory` and `ExecStart`, as well as the `User`:
79+
1. Install Python 3.
80+
2. Clone or download this repository onto the Raspberry Pi.
81+
3. Run `pip3 install -r requirements.txt`.
82+
4. If using Systemd to auto-start the program, Create the following `matrixdisplay.service` file
83+
in `/etc/systemd/system/`, making sure to change the `WorkingDirectory` and `ExecStart`, as well as the `User`:
9184

9285
```ini
9386
[Unit]
@@ -129,6 +122,12 @@ There are two configurable values located in `config.py`:
129122
- If an image is ever modified in the
130123
pictures directory, remove the corresponding file from this directory to have it be regenerated.
131124

125+
## Updating
126+
127+
1. Re-download or git pull (if you cloned) this repository.
128+
2. Run `pip3 install -r requirements.txt` to install any new requirements.
129+
3. Restart the program. (If using systemd, run `sudo systemctl restart matrixdisplay`).
130+
132131
## Home Assistant
133132

134133
This project can be added to Home Assistant using the RESTful Switch integration. The following is an example entry

0 commit comments

Comments
 (0)