From 584f7c2c75f908ebc5904c01b07b707cc9addae3 Mon Sep 17 00:00:00 2001 From: avg-lebesgue-enjoyer <141274760+avg-lebesgue-enjoyer@users.noreply.github.com> Date: Fri, 20 Sep 2024 09:20:59 +1000 Subject: [PATCH] Update README.md (#60) have --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c33d02..2d78c58 100644 --- a/README.md +++ b/README.md @@ -124,20 +124,21 @@ You can build the documentation (without spinning up a server) with `make docs`, ## Raspberry Pi Setup ### Environment -With a fresh install of Raspberry Pi OS, run the following command from the project's base directory. +Flash up your Raspberry Pi Model 3 B with a fresh install of Raspberry Pi OS (64-bit). Turn on the Raspberry Pi and record its IP address `[Target IP]`. +On your personal machine, clone into this Git repository. From the base directory, run the following command. ```bash cd bootstrap && ./bootstrap.sh [Target IP] [Username] ``` This will install python3.10 to the Pi and the dependencies for the project. ### Deployment -To deploy a build to the Raspberry Pi use the `deploy.sh` script. This script will create a tarball of file listed in a text file, transfer it to +To deploy a build to the Raspberry Pi, turn it on and run the `deploy.sh` script from your personal machine. This script will create a tarball of file listed in a text file, transfer it to a specified hostname and untar it there. To use the script execute it in the project's root directory with, ```bash ./deploy.sh [pathfile] [hostname] [username] ``` -For example, to deploy the files listed in `deploypaths.txt` to `testpi` (using username raspberry) the command would be +For example, to deploy the files listed in `deploypaths.txt` to the target IP `testpi` (using username raspberry) the command would be ```bash ./deploy.sh deploypaths.txt testpi raspberry ```