summaryrefslogtreecommitdiff
path: root/animism-align/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'animism-align/README.md')
-rw-r--r--animism-align/README.md29
1 files changed, 28 insertions, 1 deletions
diff --git a/animism-align/README.md b/animism-align/README.md
index f2c226c..4c09c65 100644
--- a/animism-align/README.md
+++ b/animism-align/README.md
@@ -13,7 +13,7 @@ npm install
## Generating waveform peaks
-Make sure your source sound is encoded as a 192 kbps CBR MP3, then generate the peaks:
+Make sure your source sound is encoded as a 192 kbps CBR MP3 (for accurate time sync), then generate the peaks:
```
ffmpeg -i original.wav -ar 44100 -b:a 192k ../data_store/peaks/episode_99.mp3
@@ -54,3 +54,30 @@ Generate a new migration if you've modified the database:
./cli.py db revision --autogenerate -m 'describe the changes'
./cli.py db upgrade head
```
+
+## Export
+
+For production, export a static version of the episode. This will make an exported folder in `data_store/exports/` which you can zip and upload somewhere.
+
+```
+./cli.py site export -o animism
+./cli.py viewer run
+```
+
+* The viewer will be running on e.g. http://0.0.0.0:5000/episode1/index.html
+* Currently no `index.html` resolution is performed.
+* For now, the site structure entails:
+
+```
+/index.html # redirects to first episode
+/episode1/index.html # episode player
+/episode1/media/... # all episode media copied here
+/static/ # non-site-media, fonts, etc
+```
+
+## History
+
+- 2020.05 - Received designs from Other Means
+- 2020.06 - Development begins
+- 2020.10 - Audio re-recorded
+- 2020.11 - Site launches with Episode 1