Add more documentation and refine github action

Author: cvanwinkle

.github/workflows/descript-build.yml

@@ -1,4 +1,4 @@
-name: descript build test
+name: build shared-libs for Descript
 
 on:
   push:
@@ -9,7 +9,7 @@ on:
 
 jobs:
   build-macos-shared:
-    name: build in native macOS
+    name: ffmpeg-ffprobe-shared-darwin
     runs-on: macos-latest
     steps:
       - name: Checkout code
@@ -20,6 +20,6 @@ jobs:
         with:
           python-version: 3.8 #install the python needed
 
-      - name: execute py script # run the run.py to get the latest data
+      - name: build-ffmpeg-descript.py
         run: |
           python ./descript/build-ffmpeg-descript.py

descript/README.md

@@ -1,3 +1,5 @@
+![](../ffmpeg-build-script.png)
+
 # Build FFmpeg for Descript
 
 ## Author / Contact:
@@ -23,8 +25,22 @@ The build script automates the following basic operations.
 
 ## Development
 Known issues:
-- .
+- CI can only build `x86_64` and doesn't yet cross-compile to `arm64`
+- When running on CI, there's libraries linked from `/usr/local/opt/...` which are non-portable
+  - Watch the script output at the end for warnings about this. These could turn into errors later.
 
 ## Patches
+- The build-ffmpeg shell script is modified directly to allow for
+  - building shared libraries
+  - disable non-free codecs
+  - add additional codecs that Descript uses
 
+## Deployment / Releases
+- Currently, the script is run manually on a developer's machine
+  - once for each platform (`x86_64` and `arm64`)
+- Build artifacts (`*.zip` files) are manually uploaded to a GitHub release and tagged
+- `SHAMSUM256.txt` files need to be merged between the two platforms when adding to a release.
 
+## Clients
+- This build is consumed by Descript's Beamcoder fork
+  - https://github.com/descriptinc/beamcoder