From 5c1e7de9e63ef2084662e6933ee50225f6404eda Mon Sep 17 00:00:00 2001 From: llccs Date: Sun, 26 Nov 2023 18:18:50 -0500 Subject: [PATCH] Create README.md --- example/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 example/README.md diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..02f68e5 --- /dev/null +++ b/example/README.md @@ -0,0 +1,8 @@ +#Getting started + +1. Build and install a binary on your application server of choice. +2. Set up a network (for production use, we suggest a dedicated network that no one is using for random internet access). +3. Load your audio files into /media (add /static/ to hold out-of-runtime content like your audio program and use /performance to hold cue media). +4. Edit agenda.yaml +5. Edit index.html to add your out-of-runtime content. Optional: edit title in live. You should not need to edit admin, rooms, or tracks. +6. /admin.html will allow you to manually fire cues. Use this to test & develop, and for monitoring during production.