diff --git a/.gitmodules b/.gitmodules index 7f814fd..ff71bc5 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ -[submodule "idiot/xlogin"] - path = idiot/xlogin +[submodule "install/xlogin"] + path = install/xlogin url = https://github.com/joukewitteveen/xlogin diff --git a/README.md b/README.md index 92b277b..2b5f44d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # Devcade-onboard The onboard menu and control software for the Devcade custom arcade system. -## Building +## Building on a devcade system -Run the `update_onboard.sh` script located in HACKING +Run the `update_onboard.sh` script located in install ## Building (manual) -To build and run on the Idiot, do the following from `/onboard`: +To build and run on the DCU, do the following from `/onboard`: ``` dotnet publish -c Release -r linux-x64 --no-self-contained ``` -To put it on the Idiot, compress the `publish` folder located at `\Devcade-onboard\onboard\bin\Release\netcoreapp3.1\linux-x64` and `scp` that to the Idiot. +To put it on the DCU (devcade compute unit), compress the `publish` folder located at `\Devcade-onboard\onboard\bin\Release\netcoreapp3.1\linux-x64` and `scp` that to the DCU. -## The Idiot +## The Devcade Compute Unit (DCU) ### Prereqs @@ -22,33 +22,35 @@ Debian >=10 A user named `devcade` -`apt install xterm openbox compton` and friends (I dont actually know what all is installed) +`apt install xinit xterm git build-essential wget openbox compton pulseaudio x11-xserver-utils` + +Also install dotnet-sdk-6.0 which requires adding microsofts package repo. ### Daemon _daemons are always watching. They are always with you. So is Willard._ -The Devcade Idiot is running Debian 10 with a very _very_ simple Xorg server setup. It has [xlogin](https://github.com/joukewitteveen/xlogin) configured to launch the onboarding program, along with said xorg server, as the `devcade` user. +The DCU is running Debian 10 with a very _very_ simple Xorg server setup. It has [xlogin](https://github.com/joukewitteveen/xlogin) configured to launch the onboarding program, along with said xorg server, as the `devcade` user. -You can find everything(tm) you need to set up the Devcade Idiot in `/idiot`. This repo has a submodule, `xlogin` that can be cloned down with `git submodule update --init --recursive`. +You can find everything(tm) you need to set up the DCU in `/install`. This repo has a submodule, `xlogin` that can be cloned down with `git submodule update --init --recursive`. -1. Run the `update_onboard.sh` script in `HACKING/` +1. Run the `update_onboard.sh` script in `install/` -2. `cp idiot/.xinitrc /home/devcade/` +2. `cp install/.xinitrc /home/devcade/` -2. `mkdir /home/devcade/.config/openbox && cp idiot/rc.xml /home/devcade/.config/openbox/rc.xml` +2. `mkdir /home/devcade/.config/openbox && cp install/rc.xml /home/devcade/.config/openbox/rc.xml` 3. To install `xlogin`, do the following ``` -cd idiot/xlogin +cd install/xlogin sudo make install sudo systemctl enable --now xlogin@devcade ``` _Helpful Tip: Remember to `chmod +x onboard`. You may get weird syntax errors if you don't_ -## HACKING +## Setting up a dev environment To setup and launch a development environment, you can do the following: @@ -65,7 +67,7 @@ DEVCADE_API_DOMAIN ### Building and Launching the Container ``` -cd HACKING +cd dev-environment ./build-environment.sh ./launch-environment.sh ``` diff --git a/HACKING/Dockerfile b/dev-environment/Dockerfile similarity index 87% rename from HACKING/Dockerfile rename to dev-environment/Dockerfile index 34dfe73..dc4bd5c 100644 --- a/HACKING/Dockerfile +++ b/dev-environment/Dockerfile @@ -1,7 +1,7 @@ FROM debian:buster RUN apt-get -y update -RUN apt-get -y install vim wget git fonts-liberation fontconfig-config tmux xterm pulseaudio zip unzip +RUN apt-get -y install vim wget git fonts-liberation fontconfig-config tmux xterm xorg compton openbox pulseaudio zip unzip RUN wget https://packages.microsoft.com/config/debian/10/packages-microsoft-prod.deb \ -O packages-microsoft-prod.deb && \ dpkg -i packages-microsoft-prod.deb && \ diff --git a/HACKING/build-environment.sh b/dev-environment/build-environment.sh old mode 100755 new mode 100644 similarity index 100% rename from HACKING/build-environment.sh rename to dev-environment/build-environment.sh diff --git a/HACKING/launch-environment.sh b/dev-environment/launch-environment.sh old mode 100755 new mode 100644 similarity index 100% rename from HACKING/launch-environment.sh rename to dev-environment/launch-environment.sh diff --git a/idiot/xlogin b/idiot/xlogin deleted file mode 160000 index 6e566b5..0000000 --- a/idiot/xlogin +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 6e566b5b399005c4f62e6c275f91a3625baa1bef diff --git a/idiot/.env b/install/.env similarity index 100% rename from idiot/.env rename to install/.env diff --git a/idiot/.xinitrc b/install/.xinitrc similarity index 100% rename from idiot/.xinitrc rename to install/.xinitrc diff --git a/idiot/rc.xml b/install/rc.xml similarity index 100% rename from idiot/rc.xml rename to install/rc.xml diff --git a/idiot/update_onboard.sh b/install/update_onboard.sh old mode 100755 new mode 100644 similarity index 100% rename from idiot/update_onboard.sh rename to install/update_onboard.sh diff --git a/onboard/release.sh b/onboard/release.sh deleted file mode 100755 index 9edad1f..0000000 --- a/onboard/release.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash -dotnet publish -c Release -r linux-x64 --no-self-contained && \ -scp -r /Devcade-onboard/onboard/bin/Release/netcoreapp3.1/linux-x64/publish/ devcade@devcade.csh.rit.edu:~/onboard-new - diff --git a/onboard/to_linux.ps1 b/onboard/to_linux.ps1 deleted file mode 100644 index 6d5259c..0000000 --- a/onboard/to_linux.ps1 +++ /dev/null @@ -1,3 +0,0 @@ -dotnet publish -c Release -r linux-x64 --no-self-contained -rm -r -force C:\Users\dingus\Documents\devcade-shared\publish\ -cp C:\Users\dingus\Code\Devcade-onboard\onboard\bin\Release\netcoreapp3.1\linux-x64\publish\ C:\Users\dingus\Documents\devcade-shared\ -r \ No newline at end of file