Merge branch 'release/v1-2-0' into feature/configure-wifi-access-point

README.md

@@ -15,12 +15,13 @@ Contributions for other boards are warmly welcome.
 ## Features
 * Add schedules for switching the relays
 * Relays are switched automatically according to schedule configuration
+* Live relay switching
+* Display Raspberry Pi system information
 * Mobile friendly web interface ([Angular](https://angular.io/) [frontend application](frontend/README.md) written in Typescript)
 * REST API ([FastAPI](https://fastapi.tiangolo.com/) [backend application](backend/README.md) written in Python)
 
-Following features are on our todo list:
-* View for live relay switching
-* View for Raspberry Pi system information
+The following features are on our todo list:
+* Set up a Wi-Fi access point on Raspberry Pi
 * Make host name for Raspberry Pi installation configurable
 * SSL for web application
 
@@ -32,21 +33,22 @@ Following features are on our todo list:
 Installation on your Raspberry Pi is **easy**! It is quickly done within minutes.
 
 Requirements:
-* Raspbian GNU/Linux v11+
-* git v2.30+
-* Python v3.9+
+* Raspbian GNU/Linux v12+ (Debian Bookworm)
+* git v2.39+
+* Python v3.11+
 
-Open a shell on your Raspberry Pi and clone this repository:
+Open a shell on your Raspberry Pi and clone this repository in /srv directory:
 ```shell
-git clone https://github.com/max-pfeiffer/irrigation-pi.git
+cd /srv
+sudo git clone https://github.com/max-pfeiffer/irrigation-pi.git
 ```
 
 Then go to project directory and run the installer script. This script installs Poetry and Python package dependencies.
 It also installs Debian package dependencies. Then it configures Irrigation-Pi application, nginx web server and
 Uvicorn application server.
 ```shell
 cd irrigation-pi
-./install.sh
+sudo ./install.sh
 ```
 Depending on your Raspberry Pi's computing power and your network connection this might take a while.
 On a Raspberry Pi 2 or 3 you need to be patient. :smiley: If package installation seems to got stuck,
@@ -63,13 +65,14 @@ All servers are configured to be fired up automatically after the Raspberry was
 ## Update
 Change to your Irrigation Pi installation directory (where you pulled the repository). Then execute the update script: 
 ```shell
-./update.sh
+cd /srv/irrigation-pi
+sudo ./update.sh
 ```
 The update script is available since v1.1.0. If you are missing it, you are running some older version. Then you need 
 to pull the latest changes from GitHub yourself like so:
 ```shell
-git checkout main
-git pull
+sudo git checkout main
+sudo git pull
 ```
 Afterwards just run the update script.
 
@@ -116,6 +119,7 @@ Options:
 Commands:
   export     Update commands.
   install    Install commands.
+  restart    Restart commands.
   run        Run commands.
   uninstall  Uninstall commands.
 ```