From f67ffaf6538d3529116c64f5a20ad7d71a62fd26 Mon Sep 17 00:00:00 2001 From: Jacob Snarr Date: Tue, 12 Mar 2024 23:40:52 -0400 Subject: [PATCH 1/2] Add documentation for SD card setup script --- .../docs/miscellaneous/_category_.json | 8 ++++ .../miscellaneous/arch-linux-ARM-setup.md | 43 +++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 documentation/docs/miscellaneous/_category_.json create mode 100644 documentation/docs/miscellaneous/arch-linux-ARM-setup.md diff --git a/documentation/docs/miscellaneous/_category_.json b/documentation/docs/miscellaneous/_category_.json new file mode 100644 index 00000000..d7030b16 --- /dev/null +++ b/documentation/docs/miscellaneous/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Miscelleanous", + "position": 12, + "link": { + "type": "generated-index", + "description": "Miscelleanous resources about BlastPad" + } +} diff --git a/documentation/docs/miscellaneous/arch-linux-ARM-setup.md b/documentation/docs/miscellaneous/arch-linux-ARM-setup.md new file mode 100644 index 00000000..f84d5c21 --- /dev/null +++ b/documentation/docs/miscellaneous/arch-linux-ARM-setup.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 1 +--- + +# Arch Linux ARM + +We made a setup script that makes it easier to install Arch Linux ARM onto an SD card. + +Before we created an image of the BlastPad's OS, this helped us set up SD cards quickly. + +## Download + +You can find the latest version of the script in our "install" directory of the main branch. [Link](https://github.com/Capstone-Projects-2024-Spring/project-blastpad/tree/main/install) + +## Run Script + +1. First, find the name of your SD card device using fdisk + +Command: +```bash +fdisk -l +``` + +Example Output: +``` +... +Disk /dev/sdb: 28.86 GiB, 30989615104 bytes, 60526592 sectors +Disk model: STORAGE DEVICE +... +``` + +*In the above example, the device name is `sdb`* + + +2. Run the script passing your device name as an argument + +```bash +sh arch_linux_arm.sh +``` + +*Following the above example, you would put `sdb` where it says ``* + + From 30299b0dd3832562ff3ed6c9046ae22aebe970b0 Mon Sep 17 00:00:00 2001 From: Jacob Snarr Date: Tue, 12 Mar 2024 23:43:23 -0400 Subject: [PATCH 2/2] Update styling and command description --- documentation/docs/miscellaneous/arch-linux-ARM-setup.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/docs/miscellaneous/arch-linux-ARM-setup.md b/documentation/docs/miscellaneous/arch-linux-ARM-setup.md index f84d5c21..d150ef1e 100644 --- a/documentation/docs/miscellaneous/arch-linux-ARM-setup.md +++ b/documentation/docs/miscellaneous/arch-linux-ARM-setup.md @@ -14,9 +14,10 @@ You can find the latest version of the script in our "install" directory of the ## Run Script -1. First, find the name of your SD card device using fdisk +**1. First, find the name of your SD card** + +We used the fdisk utility with the `-l` flag to list the block devices recognized by the OS. -Command: ```bash fdisk -l ``` @@ -32,7 +33,7 @@ Disk model: STORAGE DEVICE *In the above example, the device name is `sdb`* -2. Run the script passing your device name as an argument +**2. Run the script passing your device name as an argument** ```bash sh arch_linux_arm.sh