From 41dfa2bf2d173503d02b3c5d1a478ba7155901a4 Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Fri, 29 Apr 2022 18:18:10 +0200
Subject: [PATCH] Add OS-specific readme files to plugin archives

---
 .github/workflows/build.yml          |  2 ++
 .github/workflows/readme-Linux.txt   | 10 ++++++++++
 .github/workflows/readme-Windows.txt | 10 ++++++++++
 .github/workflows/readme-macOS.txt   | 10 ++++++++++
 4 files changed, 32 insertions(+)
 create mode 100644 .github/workflows/readme-Linux.txt
 create mode 100644 .github/workflows/readme-Windows.txt
 create mode 100644 .github/workflows/readme-macOS.txt

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 4b173f03..dd3a5407 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -75,6 +75,8 @@ jobs:
           # GitHub Action strips the top level directory, great, have another one
           mkdir -p "$ARCHIVE_NAME/$ARCHIVE_NAME"
           mv target/bundled/* "$ARCHIVE_NAME/$ARCHIVE_NAME"
+      - name: Add an OS-specific readme file with installation instructions
+        run: cp ".github/workflows/readme-${{ runner.os }}.txt" "$ARCHIVE_NAME/$ARCHIVE_NAME/README.txt"
       - uses: actions/upload-artifact@v2
         with:
           name: ${{ env.ARCHIVE_NAME }}
diff --git a/.github/workflows/readme-Linux.txt b/.github/workflows/readme-Linux.txt
new file mode 100644
index 00000000..1a2f4740
--- /dev/null
+++ b/.github/workflows/readme-Linux.txt
@@ -0,0 +1,10 @@
+To install the VST3 plugins, copy the .vst3 _directories_ to:
+~/.vst3
+
+To install the CLAP plugins, copy the .clap files to:
+~/.clap
+
+You will need to create these directories yourself it they do not yet exist.
+
+See https://github.com/free-audio/clap#hosts for instructions on how to enable
+CLAP support in your DAW.
diff --git a/.github/workflows/readme-Windows.txt b/.github/workflows/readme-Windows.txt
new file mode 100644
index 00000000..611fdb3f
--- /dev/null
+++ b/.github/workflows/readme-Windows.txt
@@ -0,0 +1,10 @@
+To install the VST3 plugins, copy the .vst3 _directories_ to:
+C:/Program Files/Common Files/VST3/
+
+To install the CLAP plugins, copy the .clap files to:
+C:/Program Files/Common Files/CLAP/
+
+You will need to create these directories yourself it they do not yet exist.
+
+See https://github.com/free-audio/clap#hosts for instructions on how to enable
+CLAP support in your DAW.
diff --git a/.github/workflows/readme-macOS.txt b/.github/workflows/readme-macOS.txt
new file mode 100644
index 00000000..5b084441
--- /dev/null
+++ b/.github/workflows/readme-macOS.txt
@@ -0,0 +1,10 @@
+To install the VST3 plugins, copy the .vst3 _directories_ to:
+~/Library/Audio/Plug-Ins/VST3
+
+To install the CLAP plugins, copy the .clap files to:
+~/Library/Audio/Plug-Ins/CLAP
+
+You will need to create these directories yourself it they do not yet exist.
+
+See https://github.com/free-audio/clap#hosts for instructions on how to enable
+CLAP support in your DAW.