From 4d70ccd633747c17c04ec11414b738a5be09bfe6 Mon Sep 17 00:00:00 2001
From: Ila Wallace <115182946+ila-w@users.noreply.github.com>
Date: Fri, 4 Oct 2024 17:11:37 -0500
Subject: [PATCH 1/2] Updated README.md for added easily copied terminal
 statements (#21)

* Updated README.md for added easily copied terminal statements

* Updated README.md regarding preventing the 0 bytes issue during setup
---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 43 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 8c003a1..2b8dc7c 100644
--- a/README.md
+++ b/README.md
@@ -12,29 +12,57 @@ You must have Python 3.9+ to build this repo. You can check with `python3 --vers
 
 ### Setup dependencies
 
-1. Pull the fprime submodule `git submodule update --init --recursive`
-1. Create a python venv `python3 -m venv fprime-venv`
-1. Activate the venv `. fprime-venv/bin/activate`
-1. Install required packages `pip install -r fprime/requirements.txt`
-1. Install the arduino-cli
-`curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh`
-1. Install the arduino-cli-wrapper `pip install arduino-cli-cmake-wrapper`
-1. Install the RP2040 board
+1. Pull the fprime submodule
+   ```sh
+   git submodule update --init --recursive
+   ```
+2. Create a python venv
+   ```sh
+   python3 -m venv fprime-venv
+   ```
+3. Activate the venv
+   ```sh
+   . fprime-venv/bin/activate
+   ```
+4. Install required packages
+   ```sh
+   pip install -r fprime/requirements.txt
+   ```
+5. Install the arduino-cli
+    ```sh
+    curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh
+    ```
+6. Install the arduino-cli-wrapper
+   ```sh
+   pip install arduino-cli-cmake-wrapper
+   ```
+7. Install the RP2040 board
     ```sh
     arduino-cli config init
+    ```
+    ```sh
     arduino-cli config add board_manager.additional_urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
-    arduino-cli core install rp2040:rp2040
     ```
-1. Install additional arduino-cli dependencies:
+    ```sh
+    arduino-cli core install rp2040:rp2040@3.9.5
+    ```
+8. Install additional arduino-cli dependencies:
     ```sh
     arduino-cli lib install Time
+    ```
+    ```sh
     arduino-cli lib install RadioHead
     ```
 
 ### Deploy onto the RP2040
-1. Build the binary `fprime-util generate rpipico && fprime-util build rpipico -j20`
-1. Move the binary from 'build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment into the Proves board over USB after it has been intialized in boot loader mode (Press both Boot loader and Reset button at the same time). This should reinit the board automatically and will run the deployment.
+1. Build the binary
+   ```sh
+   fprime-util generate rpipico && fprime-util build rpipico -j20
+   ```
+2. Move the binary from 'build-artifacts/rpipico/BroncoDeployment/bin/BroncoDeployment' into the Proves board over USB after it has been intialized in boot loader mode (Press both Boot loader and Reset button at the same time). This should reinit the board automatically and will run the deployment.
 
-Run GDS over serial:
-1. `fprime-gds -n --dictionary build-artifacts/rpipico/BroncoDeployment/dict/BroncoDeploymentTopologyAppDictionary.xml --comm-adapter uart --uart-baud 115200 --uart-device /dev/ttyACM0 --output-unframed-data -`
-- Be sure to replace '--uart-device /dev/ttyACM0' to the proper port you connect to the board!
+3. Run GDS over serial:
+   ```sh
+   fprime-gds -n --dictionary build-artifacts/rpipico/BroncoDeployment/dict/BroncoDeploymentTopologyAppDictionary.xml --comm-adapter uart --uart-baud 115200 --uart-device /dev/ttyACM0 --output-unframed-data -
+   ```
+    > **Note:** Be sure to replace '--uart-device /dev/ttyACM0' to the proper port you connect to the board!

From 707d0fd4457ff11f8a713ce8e9051e003f79c7a3 Mon Sep 17 00:00:00 2001
From: Ila Wallace <115182946+ila-w@users.noreply.github.com>
Date: Fri, 4 Oct 2024 21:04:01 -0500
Subject: [PATCH 2/2] Update README.md added copy option in markdown for the
 python command (#23)

* Update README.md added copy option in markdown for the python command

* Update README.md regarding checking the environment and cloning the repository
---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2b8dc7c..347d972 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,32 @@ F´ (F Prime) flight software for the PROVES CubeSat Kit. This version of the PR
 Getting started is easy! Please let us know if you run into any issues with the instructions below.
 
 ### Check your environment
-You must have Python 3.9+ to build this repo. You can check with `python3 --version`
+You must have Python 3.9+ and Git to build this repo. You can check with:
+```sh
+python3 --version
+```
+```sh
+git --version
+```
+> **Note**: If you do not have these downloaded to your device, please download [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/).
+
+### Cloning this repository
+1. Open your terminal or command prompt
+   
+3. Navigate to the location you want to clone the repository to using:
+   ```sh
+   cd example/path/to/the/repo/location/
+   ```
+   > **Note**: 'example/path/to/the/repo/location' is a placeholder for the path to the location you wish to put the repo
+   
+4. To clone the repository, use the following in your terminal or command prompt:
+   ```sh
+   git clone https://github.com/proveskit/fprime-proves.git
+   ```
+5. Once the repository is finished downloading, navigate into the fprime-proves directory:
+   ```sh
+   cd fprime-proves/
+   ```
 
 ### Setup dependencies