Skip to content

Commit 8f04660

Browse files
Update README.md
1 parent 9162003 commit 8f04660

File tree

1 file changed

+78
-19
lines changed

1 file changed

+78
-19
lines changed

README.md

Lines changed: 78 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,13 @@ This generator clones JUCE from [https://github.com/juce-framework/JUCE](https:/
4444
### Generate a Plugin Project
4545

4646
```bash
47-
deno run --allow-read --allow-write --allow-run --allow-net --allow-env \
48-
https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts \
49-
--name "MyAudioPlugin" \
50-
--author "Your Name" \
51-
--output ./my-audio-plugin \
52-
--with-git
47+
deno run --allow-read --allow-write --allow-run --allow-net --allow-env https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts --name "MyAudioPlugin" --author "Your Name" --output ./my-audio-plugin --with-git
5348
```
5449

5550
Or with short flags:
5651

5752
```bash
58-
deno run -A \
59-
https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts \
60-
-n "MyAudioPlugin" -a "Your Name" -o ./my-audio-plugin --with-git
53+
deno run -A https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts -n "MyAudioPlugin" -a "Your Name" -o ./my-audio-plugin --with-git
6154
```
6255

6356
### Build and Run
@@ -126,10 +119,7 @@ deno task run # Run the Standalone app
126119
By default, the generator clones the `master` branch. To use a specific version:
127120

128121
```bash
129-
deno run -A \
130-
https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts \
131-
--name "MyPlugin" \
132-
--juce-tag "7.0.9"
122+
deno run -A https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts --name "MyPlugin" --juce-tag "7.0.9"
133123
```
134124

135125
## Documentation
@@ -194,12 +184,13 @@ JUCEを使ったオーディオプラグイン開発には、従来いくつか
194184
### プラグインプロジェクトを生成
195185

196186
```bash
197-
deno run --allow-read --allow-write --allow-run --allow-net --allow-env \
198-
https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts \
199-
--name "MyAudioPlugin" \
200-
--author "Your Name" \
201-
--output ./my-audio-plugin \
202-
--with-git
187+
deno run --allow-read --allow-write --allow-run --allow-net --allow-env https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts --name "MyAudioPlugin" --author "Your Name" --output ./my-audio-plugin --with-git
188+
```
189+
190+
短いフラグを使用する場合:
191+
192+
```bash
193+
deno run -A https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts -n "MyAudioPlugin" -a "Your Name" -o ./my-audio-plugin --with-git
203194
```
204195

205196
### ビルドと実行
@@ -210,10 +201,78 @@ deno task build # Releaseモードでビルド
210201
deno task run # Standaloneアプリを実行
211202
```
212203

204+
## コマンドオプション
205+
206+
| オプション | 短縮形 | デフォルト | 説明 |
207+
|-----------|--------|-----------|------|
208+
| `--name` | `-n` | `MyPlugin` | プラグイン名 |
209+
| `--author` | `-a` | `Your Name` | 作者/会社名 |
210+
| `--version` | `-v` | `0.0.1` | プラグインバージョン |
211+
| `--output` | `-o` | (プラグイン名) | 出力ディレクトリ |
212+
| `--manufacturer-code` | | `Manu` | 4文字のメーカーコード |
213+
| `--plugin-code` | | `Plug` | 4文字のプラグインコード |
214+
| `--juce-tag` | | `master` | JUCEのgitタグ/ブランチ |
215+
| `--with-git` | | `false` | gitリポジトリを初期化 |
216+
| `--help` | `-h` | | ヘルプを表示 |
217+
218+
## 生成されるプロジェクト構造
219+
220+
```
221+
<plugin-name>/
222+
├── CMakeLists.txt # CMake設定
223+
├── deno.json # Denoタスク
224+
├── build.ts # ビルドスクリプト
225+
├── build.config.ts # ビルド設定
226+
├── cmake-file-api.ts # CMake File API連携
227+
├── cmake-types.ts # TypeScript型定義
228+
├── .gitignore
229+
├── External/
230+
│ └── JUCE/ # JUCEフレームワーク(自動クローン)
231+
└── Source/
232+
├── PluginProcessor.h
233+
├── PluginProcessor.cpp
234+
├── PluginEditor.h
235+
└── PluginEditor.cpp
236+
```
237+
238+
## 利用可能なビルドタスク
239+
240+
| タスク | 説明 |
241+
|--------|------|
242+
| `deno task build` | Releaseモードでビルド |
243+
| `deno task build:debug` | Debugモードでビルド |
244+
| `deno task clean` | ビルドディレクトリを削除 |
245+
| `deno task rebuild` | クリーンして再ビルド |
246+
| `deno task run` | ビルドしてStandaloneを実行 |
247+
| `deno task run:debug` | ビルドしてStandaloneを実行(Debug) |
248+
| `deno task format` | TypeScriptファイルをフォーマット |
249+
| `deno task lint` | TypeScriptファイルをリント |
250+
251+
## 生成されるプラグイン形式
252+
253+
- **VST3** - Windows, macOS, Linux
254+
- **AU (Audio Unit)** - macOSのみ
255+
- **Standalone** - 全プラットフォーム
256+
257+
## JUCEバージョンの指定
258+
259+
デフォルトでは `master` ブランチをクローンします。特定のバージョンを使用する場合:
260+
261+
```bash
262+
deno run -A https://raw.githubusercontent.com/cocotone/deno-juce-project-generator/main/generator/generate.ts --name "MyPlugin" --juce-tag "7.0.9"
263+
```
264+
213265
## ドキュメント
214266

215267
完全なドキュメントはこちら: https://cocotone.github.io/deno-juce-project-generator/
216268

269+
## 使用技術
270+
271+
- [JUCE](https://juce.com/) - オーディオアプリケーション向けクロスプラットフォームC++フレームワーク
272+
- [Deno](https://deno.land/) - セキュアなTypeScript/JavaScriptランタイム
273+
- [dax](https://jsr.io/@david/dax) - Deno向けクロスプラットフォームシェルツール
274+
- [CMake](https://cmake.org/) - クロスプラットフォームビルドシステム
275+
217276
## ライセンス
218277

219278
このプロジェクトはMITライセンスの下で公開されています。詳細は [LICENSE](LICENSE) ファイルを参照してください。

0 commit comments

Comments
 (0)