Update template and docs (#7)

* Update readme

* Update template version

* Update download link

* update a few more links in the docs

* Remove links to Taster

* Add new link to Vostok

* Formatting

* typo, instructions to preview docs

Author: kristianhentschelbbc

Changelog.md

@@ -3,6 +3,10 @@
 This changelog summarises changes for minor and major version bumps that end users might need to be aware of. The commit log should provide a more detailed list of changes for developers; most changes to internal systems are not discussed here.
 
 ---
+# `0.23.2` (public release)
+  _2025-01-29_
+  * Update application template, removes BBC logo from footer and updates the "made with Audio Orchestrator" link.
+
 # `0.23.1` (public release)
   _2025-01-29_
   * Change location of support and log files to `~/Library/Application Support/Audio Orchestrator` / `%APPDATA%/Audio Orchestrator`

Readme.md

@@ -4,13 +4,12 @@ _Audio Orchestrator_ is a desktop application for prototyping orchestrated audio
 
 Create a project, import audio files, and author metadata for audio objects, sequence destinations, and user controls to define the experience; then start a preview with real devices on your local network or export a web application bundle to host it on a server.
 
- * [**Download** the latest release](https://github.com/bbc/audio-orchestrator/releases).
  * [**Read** the user guide](https://bbc.github.io/audio-orchestrator).
- * [**Build** on the template application and client libraries](https://github.com/bbc/audio-orchestration).
+ * [**Extend** the template application and client libraries](https://github.com/bbc/audio-orchestration).
 
 _Audio Orchestrator_ requires `ffmpeg` and `ffprobe` to be available in the system path or a specific location in your home directory. For a manual installation, place the binaries in `~/audio-orchestrator-ffmpeg/bin` on macOS and `%HOME%\audio-orchestrator-ffmpeg\bin` on Windows. See the [installation instructions](https://bbc.github.io/audio-orchestrator/installation/) for more details.
 
-**NB** _Audio Orchestrator_ by default uses a synchronisation service currently hosted by the BBC, which may go away without warning in the future. We recommend replacing this with your own server. There are [some notes on running a self-hosted cloud-sync server](https://github.com/bbc/audio-orchestration/issues/64).
+**NB** _Audio Orchestrator_ by default uses a synchronisation server [cloud-sync](https://github.com/2-IMMERSE/cloud-sync) hosted by the BBC, which may go away without warning in the future. We recommend replacing this with your own server by setting its URL in the advanced export settings. There are [some notes on running a self-hosted cloud-sync server](https://github.com/bbc/audio-orchestration/issues/64).
 
 # Architecture overview
 
@@ -73,8 +72,16 @@ All dependencies and scripts are listed in the single `package.json` at the top
 
 Pull requests should update the main `package.json` version and run `npm install && npm run credits` before they are merged to ensure the new version is used throughout. Changelog.md should also be manually updated.
 
-Currently, releases are locally built (`npm run dist`) and manually uploaded to GitHub (macOS, macOS-arm64, Windows).
+Released binaries are currently not signed, so we recommend building Audio Orchestrator yourself from the source code using the instructions above.
+
+## Documentation
+
+The user guide hosted on GitHub pages is built automatically by a GitHub action on changes to the docs/ directory on the main branch; a local preview can be run using the `material-mkdocs` docker image:
+
+```
+docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
+```
 
 ## History
 
-_Audio Orchestrator_ was originally developed in the [BBC R&D](https://www.bbc.co.uk/rd/) Audio Team by Kristian Hentschel with contributions from Jon Francombe, Emma Young, Danial Haddadi, and Sonal Tandon between 2019 and 2022. It was distributed through the BBC _Connected Studio MakerBox_ site, and used in several public pilots on [BBC Taster](https://www.bbc.co.uk/taster/). The software is now available to interested members of the community through this Audio Orchestrator open source repository, but will not see significant further development from the BBC.
+_Audio Orchestrator_ was originally developed in the [BBC R&D](https://www.bbc.co.uk/rd/) Audio Team by Kristian Hentschel with contributions from Jon Francombe, Emma Young, Danial Haddadi, and Sonal Tandon between 2019 and 2022. It was distributed through the BBC _Connected Studio MakerBox_ site, and used in several public pilots on BBC Taster. The software is now available to interested members of the community through this Audio Orchestrator open source repository, but will not see significant further development from the BBC.

docs/index.md

@@ -9,7 +9,7 @@
 
 This documentation contains detailed guidance on how to use all of the features of *Audio Orchestrator*. If you just want to get started, it's probably best to read the [tool summary](#what-is-orchestrator) first. There's also an [example project](example.md) that's great for learning about the technology and the tool.
 
-If you run into problems, try this documentation, especially the [FAQ](faq.md) or see if a similar issue was discussed in the [GitHub issues](https://github.com/bbc/bbcat-orchestration-builder/issues).
+If you run into problems, try this documentation, especially the [FAQ](faq.md) or see if a similar issue was discussed in the [GitHub issues](https://github.com/bbc/audio-orchestrator/issues).
 
 <a name="what-is-orchestration"></a>
 ## What is audio device orchestration?

docs/installation.md

@@ -1,9 +1,8 @@
 # Installation instructions
 
-**[Download *Audio Orchestrator* from our GitHub repository](https://github.com/bbc/bbcat-orchestration-builder/releases)**
-
 To install *Audio Orchestrator*, follow the step-by-step instructions to:
 
+* **[download and build *Audio Orchestrator* from our GitHub repository](https://github.com/bbc/audio-orchestrator)**
 * [install *Audio Orchestrator* on **macOS**](installation-mac.md), or
 * [install *Audio Orchestrator* on **Windows**](installation-windows.md).
 

docs/productions.md

@@ -2,68 +2,59 @@
 
 Audio device orchestration can be used to create interactive and immersive audio experiences for multiple connected devices. This page lists a few examples made with BBC R&D's tools.
 
-## Example project
+## Pilot productions
 
-**[Listen to _Getting started with orchestration_](https://orchestrator-demos.virt.ch.bbc.co.uk/getting-started-with-orchestration){: target=_blank }** | [Find out more](example.md){: target=_blank }
+We've released a number of pilot productions on [BBC Taster](https://www.bbc.co.uk/taster){: target=_blank }. Most of the following pilots are no longer available to listen to, but you can still follow the links to find out more.
 
-When you're given access to *Audio Orchestrator* you will also receive the source files for this project. You can read more about the [example project](example.md) in the documentation.
+<a name="seeking-new-gods"></a>
+### Seeking New Gods (2021)
 
-## Pilot productions
+[Find out more](https://www.bbc.co.uk/rd/blog/2021-05-gruff-rhys-seeking-new-sounds-surround){: target=_blank }
 
-We've released a number of pilot productions on [BBC Taster](https://www.bbc.co.uk/taster){: target=_blank }.
+*Seeking New Gods* is an album by musician Gruff Rhys. Gruff and the production team used *Audio Orchestrator* to create an immersive multi-device version of the album. The mix was designed for four or more devices (although the experience works with two or more). There's also a bonus track that can only be unlocked with five or more devices. [Calibration mode](prototype.md#calibration-mode) can be used to ensure that devices are accurately synchronised.
 
 <a name="spectrum-sounds"></a>
-### Spectrum Sounds
+### Spectrum Sounds (2021)
 
-**[Listen to *Spectrum Sounds*](https://www.bbc.co.uk/taster/pilots/spectrum-sounds){: target=_blank }**  | [Find out more](https://www.bbc.co.uk/rd/blog/2021-09-hearing-synaesthesia-audio-composition-music){: target=_blank }
+[Find out more](https://www.bbc.co.uk/rd/blog/2021-09-hearing-synaesthesia-audio-composition-music){: target=_blank }
 
 *Spectrum Sounds* is a collection of seven short pieces of music (for different colours of the spectrum) by composer Andrew Hugill. The orchestrated version allows listeners to set up and control their own listening situation by disseminating sounds (and images) across three or more connected devices. You can choose to listen with or without spoken commentary by the composer, and a written transcript is also available to view in the application.
 
 [![Audio waveforms in different colours](images/productions/spectrum-sounds.jpg)](https://www.bbc.co.uk/taster/pilots/spectrum-sounds){: target=_blank }
 
 <a name="pick-a-part"></a>
-### Pick A Part
+### Pick A Part (2020)
 
-**[Listen to *Pick A Part*](https://www.bbc.co.uk/taster/pilots/pick-a-part){: target=_blank }** (UK only) | [Find out more](https://www.bbc.co.uk/rd/blog/2020-09-proms-synchronised-audio-music-interactive){: target=_blank }
+[Find out more](https://www.bbc.co.uk/rd/blog/2020-09-proms-synchronised-audio-music-interactive){: target=_blank }
 
 *Pick A Part* was created by BBC R&D and the [BBC Philharmonic](https://www.bbc.co.uk/philharmonic){: target=_blank }. It's a music experience; when you connect extra devices you can choose which instruments they play. It makes use of [calibration mode](prototype.md#calibration-mode) in the prototype application to make sure that the instruments are playing in time with each other.
 
 [![Promotional picture for Pick A Part, four phones with different instrument images on them on a table next to a laptop](images/productions/pick-a-part.jpg)](https://www.bbc.co.uk/taster/pilots/pick-a-part){: target=_blank }
 
-<a name="vostok-k"></a>
-### The Vostok-K Incident
-
-**[Listen to *The Vostok-K Incident*](https://www.bbc.co.uk/taster/pilots/vostok){: target=_blank }** | [Find out more](https://www.bbc.co.uk/rd/blog/2018-10-multi-speaker-immersive-audio-metadata){: target=_blank }
-
-*The Vostok-K Incident* is a short science fiction audio drama produced by [Naked Productions](http://nakedproductions.co.uk/){: target=_blank } as part of the [S3A Project](https://www.s3a-spatialaudio.org/){: target=_blank }. It was our first experimental orchestrated audio production, made before we built *Audio Orchestrator* but using the same underlying framework.
-
-[![Promotional picture for the Vostok-K Incident, a phone held up in front of a laptop screen](images/productions/vostok.jpg)](https://www.bbc.co.uk/taster/pilots/vostok){: target=_blank }
-
-## Pilot productions no longer available
-
-The following pilots are no longer available to listen to, but you can still follow the links to find out more.
-
-<a name="seeking-new-gods"></a>
-### Seeking New Gods
-
-**[*Seeking New Gods* on BBC Taster](https://www.bbc.co.uk/taster/pilots/seeking-new-gods){: target=_blank }** | [Find out more](https://www.bbc.co.uk/rd/blog/2021-05-gruff-rhys-seeking-new-sounds-surround){: target=_blank }
-
-*Seeking New Gods* is an album by musician Gruff Rhys. Gruff and the production team used *Audio Orchestrator* to create an immersive multi-device version of the album. The mix was designed for four or more devices (although the experience works with two or more). There's also a bonus track that can only be unlocked with five or more devices. [Calibration mode](prototype.md#calibration-mode) can be used to ensure that devices are accurately synchronised.
 
 <a name="monster"></a>
-### Monster
+### Monster (2020)
 
-**[*Monster* on BBC Taster](https://www.bbc.co.uk/taster/pilots/monster){: target=_blank }** | [Find out more](https://www.bbc.co.uk/rd/blog/2020-08-audio-drama-monster-interactive-sound){: target=_blank }
+[Find out more](https://www.bbc.co.uk/rd/blog/2020-08-audio-drama-monster-interactive-sound){: target=_blank }
 
 *Monster* is a collaboration between BBC R&D and [BBC Writersroom Wales](https://www.bbc.co.uk/writersroom/){: target=_blank }. It's an immersive horror-themed audio drama telling the story of what happens when the dead return looking for answers and someone to blame. *Monster* lasts approximately 30 minutes and is designed to require at least three connected devices. As well as audio, the devices play timed images and lighting effects.
 
-[![Promotional image for Monster, with the tile and production partner logos on top of a picture of a hand with a grainy overlay](images/productions/monster.png)](https://www.bbc.co.uk/taster/pilots/monster){: target=_blank }
+[![Promotional image for Monster, with the title and production partner logos on top of a picture of a hand with a grainy overlay](images/productions/monster.png)](https://www.bbc.co.uk/taster/pilots/monster){: target=_blank }
 
 <a name="decameron-nights"></a>
-### 1927's Decameron Nights
+### 1927's Decameron Nights (2020)
 
-**[1927's *Decameron Nights* on BBC Taster](https://www.bbc.co.uk/taster/pilots/1927s-decameron-nights){: target=_blank }** | [Find out more](https://www.bbc.co.uk/rd/blog/2020-08-audio-drama-surround-sound-spatial){: target=_blank }
+[Find out more](https://www.bbc.co.uk/rd/blog/2020-08-audio-drama-surround-sound-spatial){: target=_blank }
 
 *Decameron Nights* was created by [1927](https://www.19-27.co.uk/decameron-nights){: target=_blank } for BBC Arts and [BBC Radio 3](https://www.bbc.co.uk/programmes/m000lndx){: target=_blank }—it started life as a stereo radio production but was reimagined for orchestrated devices. Episode 1, *I'm Alright Jack*, is a trio of folk tales about "looking out for number one".
 
 [![Promotional picture for Decameron Nights, a drawing of five cats](images/productions/decameron-nights.jpg)](https://www.bbc.co.uk/taster/pilots/1927s-decameron-nights){: target=_blank }
+
+<a name="vostok-k"></a>
+### The Vostok-K Incident (2018)
+
+**[Listen to The Vostok-K Incident](https://vostok.audio.bbctest01.uk/){: target=_blank }** | [Find out more](https://www.bbc.co.uk/rd/blog/2018-10-multi-speaker-immersive-audio-metadata){: target=_blank }
+
+*The Vostok-K Incident* is a short science fiction audio drama produced by [Naked Productions](http://nakedproductions.co.uk/){: target=_blank } as part of the [S3A Project](https://www.s3a-spatialaudio.org/){: target=_blank }. It was our first experimental orchestrated audio production, made before we built *Audio Orchestrator* but using the same underlying framework.
+
+[![Promotional picture for the Vostok-K Incident, a phone held up in front of a laptop screen](images/productions/vostok.jpg)](https://www.bbc.co.uk/taster/pilots/vostok){: target=_blank }

electron-app/credits.html

@@ -12,7 +12,7 @@
   </head>
   <body>
     <h1>About Audio Orchestrator</h1>
-    <p>Version 0.23.1</p>
+    <p>Version 0.23.2</p>
     <p>Copyright BBC R&amp;D</p>
     <p>User guide: https://bbc.github.io/audio-orchestrator</p>
     <p>Source code: https://github.com/bbc/audio-orchestrator</p>
@@ -59,7 +59,7 @@ <h2>@babel/[email protected]</h2>
 </pre>
 </li>
 <li tabindex="1">
-<h2>@bbc/[email protected].1</h2>
+<h2>@bbc/[email protected].2</h2>
 <pre>
 Website: https://github.com/bbc/audio-orchestration
 
@@ -84,7 +84,7 @@ <h2>@bbc/[email protected]</h2>
 </pre>
 </li>
 <li tabindex="1">
-<h2>@bbc/[email protected].1</h2>
+<h2>@bbc/[email protected].2</h2>
 <pre>
 Website: https://github.com/bbc/audio-orchestration
 
@@ -294,7 +294,7 @@ <h2>@bbc/[email protected]</h2>
 </pre>
 </li>
 <li tabindex="1">
-<h2>@bbc/[email protected].1</h2>
+<h2>@bbc/[email protected].2</h2>
 <pre>
 Website: https://github.com/bbc/audio-orchestration
 
@@ -319,7 +319,7 @@ <h2>@bbc/[email protected]</h2>
 </pre>
 </li>
 <li tabindex="1">
-<h2>@bbc/[email protected].1</h2>
+<h2>@bbc/[email protected].2</h2>
 <pre>
 Website: https://github.com/bbc/audio-orchestration
 

mkdocs.yml

@@ -1,6 +1,7 @@
 site_name: Audio Orchestrator documentation
 site_url: https://bbc.github.io/audio-orchestrator/
-copyright: Copyright © 2025 BBC
+repo_url: https://github.com/bbc/audio-orchestrator
+copyright: Copyright © BBC
 theme:
   name: 'material'
   font: false