From 0e7c1b080d8c9e424a3f578cc32f0dbe4549e791 Mon Sep 17 00:00:00 2001
From: Boaz Sender <boazsender@protonmail.com>
Date: Sun, 30 Mar 2025 15:26:13 -0700
Subject: [PATCH] improve docs

---
 docs/broadcaster.md | 28 +++++++-----------
 docs/listener.md    | 72 +++++++++++++++++----------------------------
 2 files changed, 38 insertions(+), 62 deletions(-)

diff --git a/docs/broadcaster.md b/docs/broadcaster.md
index 1646d07..4e298ba 100644
--- a/docs/broadcaster.md
+++ b/docs/broadcaster.md
@@ -26,23 +26,21 @@ Running icecast and darkice. See icecast-darkice.md for setup instructions.
 
 ## Setup instructions
 ### Creature comforts
-sudo apt update && install git vim zsh
-sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
+1. sudo apt update && install git vim zsh
+2. sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
 
 ### Icecast2 and Darkice installation
-Follow this tutorial: https://dev.to/shilleh/stream-audio-from-raspberry-pi-to-local-computer-1a1c
+Loosely following this tutorial: https://dev.to/shilleh/stream-audio-from-raspberry-pi-to-local-computer-1a1c
 
 
 #### Install icecast2
-sudo apt install icecast2 
-
-It will ask you for three passwords. Set them all as emergence.
+1. sudo apt install icecast2 
+2. It will ask you for three passwords. Set them all as emergence.
 
 
 #### Install darkice
-sudo apt install darkice
-
-sudo vim /etc/darkice.cfg
+1. sudo apt install darkice
+2. sudo vim /etc/darkice.cfg
 
 ```
 [general]
@@ -72,8 +70,7 @@ public = no # Do not list on public lists
 ```
 
 #### Daemonize darkice
-
-sudo vim /lib/systemd/system/darkice.service
+1. sudo vim /lib/systemd/system/darkice.service
 ```
 [Unit]
 Description=Darkice Service
@@ -87,10 +84,7 @@ ExecStart=/usr/bin/darkice -c /etc/darkice.cfg
 [Install]
 WantedBy=multi-user.target
 ```
-
-sudo systemctl daemon-reload
-
-sudo systemctl enable icecast2
-
-sudo systemctl enable darkice
+2. sudo systemctl daemon-reload
+3. sudo systemctl enable icecast2
+4. sudo systemctl enable darkice
 
diff --git a/docs/listener.md b/docs/listener.md
index b64db25..37d641c 100644
--- a/docs/listener.md
+++ b/docs/listener.md
@@ -32,24 +32,22 @@ Running mplayer, soundcard library, lcd graphics library, and custom python code
 
 ## Setup instructions
 ### Creature comforts
-sudo apt update && install git vim zsh
-sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
-
-### Waveshare soud card drivers
-Follw instructions at https://www.waveshare.com/wiki/WM8960_Audio_HAT
-
+1. sudo apt update && install git vim zsh
+2. sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
 
+### Install Waveshare soud card drivers
 #### Install drivers
-git clone https://github.com/waveshare/WM8960-Audio-HAT
-cd WM8960-Audio-HAT
-sudo ./install.sh 
-sudo reboot
-sudo dkms status 
+Following instructions instructions at https://www.waveshare.com/wiki/WM8960_Audio_HAT
 
-Check for drivers installed
+1. git clone https://github.com/waveshare/WM8960-Audio-HAT
+2. cd WM8960-Audio-HAT
+3. sudo ./install.sh 
+4. sudo reboot
+5. sudo dkms status 
+6. Check the output of dkms to confirm that drivers installed correctly
+7. sudo apt install mplayer
 
-#### Test drivers
-sudo apt install mplayer
+#### Test radio
 mplayer -playlist http://blackportaldetroit.com:1313/portal.m3u
 
 #### Daemonize radio
@@ -78,40 +76,23 @@ sudo reboot
 alsamixer 
 sudo alsactl store
 
-### LCD Screen
-Follow https://peppe8o.com/1602-lcd-raspberry-pi-display/
-
-sudo apt install python3-pip python3-smbus i2c-tools -y
-sudo raspi-config 
-
-enable i2c in interface options
+### LCD screen and sound processing logic
+Install software from this repo
 
 
+1. sudo raspi-config 
+2. enable i2c in interface options
+3. i2cdetect -y 1
+4. confirm that i2cdetect tells you the address 27.
 
+5. curl https://get.volta.sh | bash
+6. volta install node
+7. git clone git@git.featherboaz.com:boazsender/portal.git
 
-python3 -m venv screen --system-site-packages
-source ./screen/bin/activate
+8. cd portal && npm install 
+9. npx prisma generate && npx prisma db push && npx prisma db seed
 
-pip3 install adafruit-circuitpython-charlcd
-
-wget https://peppe8o.com/download/python/lcd/i2c-lcd-test-01-hello-world.py
-
-i2cdetect -y 1
-
-python3 i2c-lcd-test-01-hello-world.py
-
-
----
-
-curl https://get.volta.sh | bash
-volta install node
-
-git clone git@git.featherboaz.com:boazsender/portal.git
-
-cd portal && npm install 
-npx prisma generate && npx prisma db push && npx prisma db seed
-
-sudo vim /lib/systemd/system/screen.service
+10. sudo vim /lib/systemd/system/screen.service
 ```
 [Unit]
 Description=Screen Service
@@ -126,5 +107,6 @@ ExecStart=/home/grace/.volta/bin/node /home/grace/portal/build/screen.js
 [Install]
 WantedBy=multi-user.target
 ```
-sudo systemctl daemon-reload
-sudo systemctl enable listener
\ No newline at end of file
+11. sudo systemctl daemon-reload
+12. sudo systemctl enable listener
+