move setup instructions to readme

README.md

@@ -2,9 +2,48 @@
 
 Please see [my blog post for more details](https://www.xythobuz.de/osci_music_player.html).
 
-Quick start instructions can be found in the top comment of the Python script in this repo.
+[Oscilloscope Music](https://oscilloscopemusic.com) Player for Raspberry Pi.
+Tested with a [Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/), connected to a [HiFiBerry DAC+ Zero](https://www.hifiberry.com/shop/boards/hifiberry-dac-zero/), running [Raspberry Pi OS (Legacy, 32bit) Lite](https://downloads.raspberrypi.com/raspios_oldstable_lite_armhf/images/raspios_oldstable_lite_armhf-2023-12-06/2023-12-05-raspios-bullseye-armhf-lite.img.xz).
+Powered by [PiSugar 2](https://github.com/PiSugar/pisugar-power-manager-rs) and their [Python API](https://github.com/PiSugar/pisugar-server-py).
 
-    ssh osci-music "sudo systemctl disable --now osci.service" && scp osci-pi.py osci-music:~ && ssh osci-music "sudo systemctl enable --now osci.service"
-
-Also include a simple script to convert single SVG paths to audio.
+Also includes a simple script to convert single SVG paths to audio.
 Run the included makefile to convert the SVG files in this directory.
+
+## Quick Start
+
+Prepare a SD card with the Raspbian as linked above.
+Then run the following commands.
+
+    sudo sh -c 'echo "dtoverlay=hifiberry-dac" >> /boot/config.txt'
+    sudo apt-get update
+    sudo apt-get install python3 python3-pip python3-pil libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libopenjp2-7 libtiff5 ffmpeg git vim
+    curl http://cdn.pisugar.com/release/pisugar-power-manager.sh | sudo bash
+    pip install pisugar
+    pip install luma.oled
+    pip install psutil
+    sudo usermod -a -G spi,gpio,i2c $USER
+    cd ~
+    git clone https://git.xythobuz.de/thomas/osci-music-player
+    sudo cp osci-music-player/osci.service /etc/systemd/system/osci.service
+    # edit username in /etc/systemd/system/osci.service as needed
+    sudo systemctl daemon-reload
+    sudo systemctl enable osci.service
+    sudo reboot
+
+To quickly test new changes to the script:
+
+    ssh osci-music "sudo systemctl disable --now osci.service" && scp osci-pi.py osci-music:~/osci-music-player && ssh osci-music "sudo systemctl enable --now osci.service"
+
+## License
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    See <http://www.gnu.org/licenses/>.

osci-pi.py

@@ -1,34 +1,5 @@
 #!/usr/bin/env python3
 
-# Oscilloscope Music Player for Raspberry Pi
-# https://oscilloscopemusic.com
-#
-# Tested with a Pi Zero 2 W:
-# https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/
-#
-# Connected to a HiFiBerry DAC+ Zero:
-# https://www.hifiberry.com/shop/boards/hifiberry-dac-zero/
-#
-# Tested with Raspberry Pi OS (Legacy, 32bit) Lite:
-# https://downloads.raspberrypi.com/raspios_oldstable_lite_armhf/images/raspios_oldstable_lite_armhf-2023-12-06/2023-12-05-raspios-bullseye-armhf-lite.img.xz
-#
-# Add "dtoverlay=hifiberry-dac" to "/boot/config.txt"
-#
-# Install ffmpeg for the ffplay dependency
-#
-# Powered by PiSugar 2:
-# https://github.com/PiSugar/pisugar-power-manager-rs
-# https://github.com/PiSugar/pisugar-server-py
-#
-#     sudo sh -c 'echo "dtoverlay=hifiberry-dac" >> /boot/config.txt'
-#     sudo apt-get update
-#     sudo apt-get install python3 python3-pip python3-pil libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libopenjp2-7 libtiff5 ffmpeg
-#     curl http://cdn.pisugar.com/release/pisugar-power-manager.sh | sudo bash
-#     pip install pisugar
-#     pip install luma.oled
-#     pip install psutil
-#     sudo usermod -a -G spi,gpio,i2c $USER
-#
 # IP address code taken from:
 # https://github.com/rm-hull/luma.examples/blob/master/examples/sys_info_extended.py
 #

osci.service

@@ -5,7 +5,7 @@ After=multi-user.target
 [Service]
 Type=idle
 User=thomas
-ExecStart=/home/thomas/osci-pi.py /home/thomas/music
+ExecStart=/home/thomas/osci-music-player/osci-pi.py /home/thomas/music
 Restart=always
 RestartSec=5