add linux installation guide

openvpi · Oct 3, 2024 · 17b3237 · 17b3237
1 parent e514eaa
commit 17b3237
Show file tree

Hide file tree

Showing 8 changed files with 105 additions and 1 deletion.
diff --git a/.github/workflows/generate-bundles-and-release.yml b/.github/workflows/generate-bundles-and-release.yml
@@ -162,12 +162,15 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
         shell: pwsh
         run: |
+          cd scripts/setup/linux
           mv $env:DIFFSCOPE_INSTALLED_DIR DiffScope
           mkdir "DiffScope Bridge"
           Invoke-WebRequest -Uri "https://raw.githubusercontent.com/CrSjimo/diffscope-ci-tools-mirror/refs/heads/main/gpl-3.0.rtf" -OutFile "DiffScope Bridge/gpl-3.0.rtf"
           mv $env:DIFFSCOPE_BRIDGE_ARTEFACTS_DIR/VST3/*.vst3 "DiffScope Bridge"
           mv $env:DIFFSCOPE_BRIDGE_ARTEFACTS_DIR/LV2/*.lv2 "DiffScope Bridge"
-          tar --bzip2 -cf "$env:BINARY_NAME.tar.bz2" DiffScope "DiffScope Bridge"
+          mv create-desktop-entry.sh DiffScope
+          mv remove-desktop-entry.sh DiffScope
+          tar --bzip2 -cf "$env:BINARY_NAME.tar.bz2" DiffScope "DiffScope Bridge" "Installation Guide.txt"
           Write-Output PACKAGE_PATH=$(Resolve-Path -Path "$env:BINARY_NAME.tar.bz2") >> $env:GITHUB_ENV
 
       - name: Upload release file

diff --git a/docs/linux-installation-guide-ja_JP.md b/docs/linux-installation-guide-ja_JP.md
@@ -0,0 +1,17 @@
+# Linux 用 DiffScope インストールガイド
+
+## DiffScope をインストール
+
+1. このアーカイブを解凍し、`DiffScope` ディレクトリをインストールしたい場所に移動します (`/opt` が推奨されます)。
+
+2. `DiffScope/bin/DiffScope` を実行して DiffScope を起動します。
+
+## デスクトップのエントリを作成
+
+`DiffScope/create-desktop-entry.sh` を実行して、DiffScope のデスクトップのエントリを作成します。
+
+`DiffScope/remove-desktop-entry.sh` を実行して、後で削除します。
+
+## DiffScope Bridge をインストール [オプション]
+
+DiffScope Bridge は、`DiffScope Bridge` ディレクトリに VST3 および LV2 形式で提供されています。インストールするには、このアーカイブを解凍し、これらのプラグインバンドルをプラグインの場所に移動してください。
diff --git a/docs/linux-installation-guide-zh_CN.md b/docs/linux-installation-guide-zh_CN.md
@@ -0,0 +1,17 @@
+# Linux 版 DiffScope 安装指南
+
+## 安装 DiffScope
+
+1. 解压此存档并将`DiffScope`目录移动到要安装的位置（建议使用`/opt`）。
+
+2. 执行`DiffScope/bin/DiffScope`以启动 DiffScope。
+
+## 创建桌面条目
+
+运行`DiffScope/create-desktop-entry.sh`以创建 DiffScope 的桌面条目。
+
+运行`DiffScope/remove-desktop-entry.sh`以在之后将其删除。
+
+## 安装 DiffScope Bridge [可选]
+
+`DiffScope Bridge`目录中提供 VST3 和 LV2 格式的 DiffScope Bridge。要安装，请解压此存档并将这些插件包移动到插件位置。
diff --git a/docs/linux-installation-guide-zh_TW.md b/docs/linux-installation-guide-zh_TW.md
@@ -0,0 +1,17 @@
+# Linux 版 DiffScope 安裝指南
+
+## 安裝 DiffScope
+
+1. 解壓縮此檔案並將`DiffScope`目錄移至要安裝的位置（建議使用`/opt`）。
+
+2. 執行`DiffScope/bin/DiffScope`以啟動 DiffScope。
+
+## 建立桌面條目
+
+執行`DiffScope/create-desktop-entry.sh`以建立 DiffScope 的桌面條目。
+
+執行`DiffScope/remove-desktop-entry.sh`以在之後將其刪除。
+
+## 安裝 DiffScope Bridge [可選]
+
+`DiffScope Bridge`目錄中提供 VST3 和 LV2 格式的 DiffScope Bridge。要安裝，請解壓縮此存檔並將這些外掛包移至外掛位置。
diff --git a/docs/linux-installation-guide.md b/docs/linux-installation-guide.md
@@ -0,0 +1,19 @@
+# DiffScope Installation Guide for Linux
+
+Read in other languages: [简体中文](linux-installation-guide-zh_CN.md) | [繁体中文](linux-installation-guide-zh_TW.md) | [日本語](linux-installation-guide-ja_JP.md)
+
+## Install DiffScope
+
+1. Unpack this archive and move the `DiffScope` directory to where you wish to install it (`/opt` is suggested).
+
+2. Execute `DiffScope/bin/DiffScope` to start DiffScope.
+
+## Create Desktop Entry
+
+Run `DiffScope/create-desktop-entry.sh` to create a desktop entry of DiffScope.
+
+Run `DiffScope/remove-desktop-entry.sh` to remove it later.
+
+## Install DiffScope Bridge [optional]
+
+DiffScope Bridge is provided in VST3 and LV2 format in the "DiffScope Bridge" directory. To install, please unpack this archive and move these plugin bundles to the plugin location.
diff --git a/scripts/setup/linux/Installation Guide.txt b/scripts/setup/linux/Installation Guide.txt
@@ -0,0 +1,25 @@
+DiffScope Installation Guide
+============================
+
+Read in other languages / 以其它语言阅读 / 以其它語言閱讀 / 他の言語で読みます:
+<https://github.com/openvpi/diffscope/blob/main/docs/linux-installation-guide.md>
+
+Install DiffScope
+-----------------
+
+1. Unpack this archive and move the "DiffScope" directory to where you wish to install it ("/opt" is suggested).
+
+2. Execute "DiffScope/bin/DiffScope" to start DiffScope.
+
+Create Desktop Entry
+--------------------
+
+Run "DiffScope/create-desktop-entry.sh" to create a desktop entry of DiffScope.
+
+Run "DiffScope/remove-desktop-entry.sh" to remove it later.
+
+Install DiffScope Bridge [optional]
+-----------------------------------
+
+DiffScope Bridge is provided in VST3 and LV2 format in the "DiffScope Bridge" directory. To install, please unpack this
+archive and move these plugin bundles to the plugin location.
diff --git a/scripts/setup/linux/create-desktop-entry.sh b/scripts/setup/linux/create-desktop-entry.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+# TODO
diff --git a/scripts/setup/linux/remove-desktop-entry.sh b/scripts/setup/linux/remove-desktop-entry.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+# TODO