From c81e14bb52fef0191564c8eebbdfcb25193b4805 Mon Sep 17 00:00:00 2001 From: Kevin Matz Date: Mon, 4 Nov 2019 10:50:38 -0500 Subject: [PATCH] Update 'README.md' --- README.md | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 550f5d4..291e417 100644 --- a/README.md +++ b/README.md @@ -5,50 +5,57 @@ Use buttons connected to a Rasberry Pi GPIO to trigger Hog 4 comment macros. * Install Raspbian [the usual way.](https://www.raspberrypi.org/documentation/installation/installing-images/README.md) * Enable the ssh server. On a mac: -``` +```sh touch /Volumes/boot/ssh ``` + * Eject the SD card and boot the Raspberry Pi. * Use SSH to log into the Pi: -``` +```sh ssh pi@raspberrypi ``` + * Use raspi-config to; +```sh +sudo raspi-config +``` * set locale * set timezone * enable ssh server * enlarge the file-system to fill the SD card * reboot -``` -sudo raspi-config -``` + + * Update the Apt and install aptitude -``` +```sh sudo apt-get update sudo apt-get install aptitude ``` + * Use aptitude to upgrade the Pi. -``` +```sh sudo aptitude upgrade ``` + * Reboot the Pi. -``` +```sh sudo shutdown -r now ``` + * Logging back into the Pi, install sane set of software packages. -``` +```sh sudo aptitude install git python3-pip python3-gpiozero sudo pip3 install gpiozero antlr4-python3-runtime python-osc ``` ## Installing -``` +```sh cd /home/pi git clone --recurse-submodules https://git.company235.com/kevin/onsetswitch.git cd onsetswitch ``` -RaspberryRaspberry + ## Configuring @@ -58,30 +65,30 @@ Connect one side of the button to ground, the other to a GPIO pin. ![](https://gpiozero.readthedocs.io/en/stable/_images/button_bb.svg) Configure the buttons: -``` +```sh nano buttons.cfg ``` ### Output Configure the Hog4 OSC server: -``` +```sh nano server.cfg ``` ## Enabling on Boot Link the onsetswitch service file to systemd: -``` +```sh sudo ln -s buttons.service /lib/systemd/system/buttons.service ``` Enable the service at startup: -``` +```sh sudo systemctl daemon-reload sudo systemctl enable buttons.service ``` Reboot the Raspberry Pi: -``` +```sh sudo reboot ```