Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
llccs authored Nov 26, 2023
1 parent 24acb0a commit 5c1e7de
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 5c1e7de

Please sign in to comment.