Update documentation (#2037)

* docs: replace old info with up-to-date info
* docs: add follow-up info about the devices where the installer doesn't work

README.md

@@ -17,9 +17,11 @@ We've tested Anthias and is known to work on the following Raspberry Pi models:
 
 * Raspberry Pi 4 Model B - 32-bt and 64-bit Bullseye, 64-bit Bookworm
 * Raspberry Pi 3 Model B+ - 32-bit and 64-bit Bullseye, 64-bit Bookworm
-* Raspberry Pi 3 Model B - 64-bit Bookworm
+* Raspberry Pi 3 Model B - 64-bit Bookworm and Bullseye
+* Raspberry Pi 2 Model B - 32-bit Bookworm and Bullseye
 
-We're still fixing the installer so that it'll work with Raspberry Pi Zero and Raspberry Pi 2.
+
+We're still fixing the installer so that it'll work with Raspberry Pi Zero and Raspberry Pi 1.
 Should you encounter any issues, please file an issue either in this repository or in the
 [forums](https://forums.screenly.io).
 
@@ -131,7 +133,7 @@ If it's not, you need to run the script again and enter a valid tag.
 
 #### Prompt: Full System Upgrade
 
-If you've selected **Yes** when prompted for an upgrade – i.e., "Would you like to perform a full system upgrade as well? (y/N)"
+If you've selected **Yes** when prompted for an upgrade – i.e., "Would you like to perform a full system upgrade as well?"
 – you'll get the following message when the installer is almost done executing:
 
 ```
@@ -159,26 +161,26 @@ This feature is only available in devices running Raspberry Pi OS at the moment.
 To get started, SSH to your Raspberry Pi running Anthias. For instance:
 
 ```bash
-ssh pi@raspberrypi
+$ ssh pi@raspberrypi
 ```
 
 Go to the project root directory and create a Python virtual environment, if you haven't created one.
 
 ```bash
-cd ~/screenly
-python -m venv venv/
+$ cd ~/screenly
+$ python -m venv venv/
 ```
 
 Activate the virtual environment. You need to do this everytime right before you run the script.
 
 ```bash
-source ./venv/bin/activate
+$ source ./venv/bin/activate
 ```
 
 Install the dependencies required by the assets migration script.
 
 ```bash
-pip install -r requirements/requirements.local.txt
+$ pip install -r requirements/requirements.local.txt
 ```
 
 Before running the script, you should prepare the following:
@@ -188,7 +190,7 @@ Before running the script, you should prepare the following:
 Run the assets migration script. Follow through the instructions & prompts carefully.
 
 ```bash
-python tools/migrate-assets-to-screenly.py
+$ python tools/migrate-assets-to-screenly.py
 ```
 
 ## Issues and bugs

docs/README.md

@@ -90,8 +90,8 @@ This section only works for devices running Raspberry Pi OS Lite.
 With running the following script, you can install self-signed certificates:
 
 ```bash
-cd $HOME/screenly
-./bin/add_certificate.sh /path/to/certificate.crt
+$ cd $HOME/screenly
+$ ./bin/add_certificate.sh /path/to/certificate.crt
 ```
 
 More details about generating self-signed certificates can be found [here](https://devopscube.com/create-self-signed-certificates-openssl/).

docs/developer-documentation.md

@@ -99,13 +99,13 @@ to get started.
 Run the following command from the project root directory.
 
 ```bash
-npm install
+$ npm install
 ```
 
 ### Transpiling CSS from SASS
 
 ```bash
-npm run sass-dev
+$ npm run sass-dev
 ```
 
 ### Transpiling JS from CoffeeScript
@@ -113,7 +113,7 @@ npm run sass-dev
 ```bash
 # You need to run this on a separate terminal session if you already ran the
 # script for transpiling SASS files.
-npm run coffee-dev
+$ npm run coffee-dev
 ```
 
 ### Closing the transpiler

docs/wifi-setup.md

@@ -83,7 +83,7 @@ You can also check to see if the `wlan0` interface is assigned an IPv4 address.
 If so, then you're all set.
 
 ```shell
-ip addr show wlan0
+$ ip addr show wlan0
 ```
 
 Here's a sample output: