From a9a28eb1fbf034ad7451f318abe4cff0af30bb0c Mon Sep 17 00:00:00 2001 From: 2mal3 <56305732+2mal3@users.noreply.github.com> Date: Sun, 9 Nov 2025 00:01:53 +0100 Subject: [PATCH] docs: centralized dev --- CONTRIBUTING.md | 11 +++++++++++ README.md | 10 ++++++++++ control/README.md | 3 --- display/README.md | 16 ---------------- 4 files changed, 21 insertions(+), 19 deletions(-) delete mode 100644 control/README.md delete mode 100644 display/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e0dab0..a975f82 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,3 +21,14 @@ The _Control Block_ controls multiple Display Blocks via a user interface. One D - **TailwindCSS** for styling the frontend of the Control Block. - **Chromium** browser for handling most media display in the Display Block and serving the frontend of the Control Block. - **LibreOffice** for handling more complex documents in the Display Block. + +### Requirements + +- Go v1.25 or higher +- Deno v2 + +### Running + +1. open the wanted folder of the block inside a terminal +2. run `go generate ./..` to generate files required at build time +3. run `go run *.go` to compile and run the block diff --git a/README.md b/README.md index db93994..eeec660 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ Open source solution for advanced remote control and coordination of one or more presentation displays. Specially optimized for fast operation in highly dynamic multi-display situations. +## Display Requirements + +- Linux +- Bash +- Chromium +- LibreOffice (optional, presentation view) +- ImageMagick (optional, image preview) +- ffmpeg (optional, video preview) +- Ghostscript (optional, pdf preview) + ## Contributing See [Contributing.md](/CONTRIBUTING.md) diff --git a/control/README.md b/control/README.md deleted file mode 100644 index 569b8af..0000000 --- a/control/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# PLG-MuDiCS Control - -## Development diff --git a/display/README.md b/display/README.md deleted file mode 100644 index 9c1e583..0000000 --- a/display/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# PLG-MuDiCS Display - -## Runtime Requirements - -- Bash -- Chromium -- LibreOffice (presentation view) -- ImageMagick (file preview) -- ffmpeg (file preview) -- Ghostscript (file preview) - -## Development Setup - -- install Go (at least version v1.25) -- build template: `go generate ./..` -- run code: `go run .`