From a2e49bde5f66e81e37a2ad5d6267e560415e5fe0 Mon Sep 17 00:00:00 2001
From: Jack Wills <32690432+mrjackwills@users.noreply.github.com>
Date: Fri, 17 Feb 2023 18:42:26 +0000
Subject: [PATCH] docs: readme use shell code blocks

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 45 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 07fd330..6f7771b 100644
--- a/README.md
+++ b/README.md
@@ -21,34 +21,45 @@
 ### Cargo
 Published on <a href='https://www.crates.io/crates/oxker' target='_blank' rel='noopener noreferrer'>crates.io</a>, so if you have cargo installed, simply run
 
-```cargo install oxker```
+
+```shell
+cargo install oxker
+```
 
 ### Docker
 Published on <a href='https://hub.docker.com/r/mrjackwills/oxker' target='_blank' rel='noopener noreferrer'>Docker Hub</a>, with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6`
 
-`docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker`
+```shell
+docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker
+```
 
 ### Nix
 Using nix flakes, oxker can be ran directly with
 
-```nix run nixpkgs#oxker```
+```shell
+nix run nixpkgs#oxker
+```
 
 Without flakes, you can build a shell that contains oxker using
 
-```nix-shell -p oxker```
+```shell
+nix-shell -p oxker
+```
 
 ### AUR
 
 oxker can be installed from the [AUR](https://aur.archlinux.org/packages/oxker) with using an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers):
 
-```paru -S oxker```
+```shell
+paru -S oxker
+```
 
 ### Pre-Built
 See the <a href="https://github.com/mrjackwills/oxker/releases/latest" target='_blank' rel='noopener noreferrer'>pre-built binaries</a>
 
 or, download & install (x86_64 one liner)
 
-```bash
+```shell
 wget https://www.github.com/mrjackwills/oxker/releases/latest/download/oxker_linux_x86_64.tar.gz &&
 tar xzvf oxker_linux_x86_64.tar.gz oxker &&
 install -Dm 755 oxker -t "${HOME}/.local/bin" &&
@@ -59,13 +70,15 @@ or, for automatic platform selection, download, and installation (to `$HOME/.loc
 
 *One should always verify script content before running in a shell*
 
-```bash
+```shell
 curl https://raw.githubusercontent.com/mrjackwills/oxker/main/install.sh | bash
 ```
 
 ## Run
 
-```oxker```
+```shell
+oxker
+```
 
 In application controls
 | button| result|
@@ -94,7 +107,9 @@ Available command line arguments
 
 ### x86_64
 
-```cargo build --release```
+```shell
+cargo build --release
+```
 
 ### Raspberry pi
 
@@ -102,13 +117,17 @@ requires docker & <a href='https://github.com/cross-rs/cross' target='_blank' re
 
 #### 64bit pi (pi 4, pi zero w 2)
 
-```cross build --target aarch64-unknown-linux-gnu --release```
+```shell
+cross build --target aarch64-unknown-linux-gnu --release
+```
 
 #### 32bit pi (pi zero w)
 
 Tested, and fully working on pi zero w, running Raspberry Pi OS 32 bit, the initial logs parsing can take an extended period of time if thousands of lines long, suggest running with a -d argument of 5000
 
-```cross build --target arm-unknown-linux-musleabihf --release```
+```shell
+cross build --target arm-unknown-linux-musleabihf --release
+```
 
 If no memory information available, try appending ```/boot/cmdline.txt``` with
 
@@ -122,18 +141,28 @@ see <a href="https://forums.raspberrypi.com/viewtopic.php?t=203128" target='_bla
 
 As of yet untested, needs work
 
-```cargo test -- --test-threads=1```
+```shell
+cargo test -- --test-threads=1
+```
 
 Run some example docker images
 
 using docker-compose.yml;
 
-```docker compose -f docker-compose.yml up -d```
+```shell
+docker compose -f docker-compose.yml up -d
+```
 
 or individually
 
-```docker run --name redis -d redis:alpine3.17```
+```shell
+docker run --name redis -d redis:alpine3.17
+```
 
-```docker run --name postgres -e POSTGRES_PASSWORD=never_use_this_password_in_production -d postgres:alpine3.17```
+```shell
+docker run --name postgres -e POSTGRES_PASSWORD=never_use_this_password_in_production -d postgres:alpine3.17
+```
 
-```docker run -d --hostname my-rabbit --name rabbitmq rabbitmq:3```
+```shell
+docker run -d --hostname my-rabbit --name rabbitmq rabbitmq:3
+```