docs: centralized dev

This commit is contained in:
2025-11-09 00:01:53 +01:00
parent e030b0469c
commit a9a28eb1fb
4 changed files with 21 additions and 19 deletions
+11
View File
@@ -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. - **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. - **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. - **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
+10
View File
@@ -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. 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 ## Contributing
See [Contributing.md](/CONTRIBUTING.md) See [Contributing.md](/CONTRIBUTING.md)
-3
View File
@@ -1,3 +0,0 @@
# PLG-MuDiCS Control
## Development
-16
View File
@@ -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 .`