commit 19
This commit is contained in:
64
readme.md
64
readme.md
@@ -1,43 +1,47 @@
|
||||
# Strudel Code Assistant (Gemini CLI Skills)
|
||||
# Strudel Live Coding Notebook with Gemini CLI
|
||||
|
||||
このプロジェクトは、Gemini CLIの「Skills」機能を活用して、Strudelスクリプトの解説、構文修正、およびリファクタリングを自動化するためのツール群です。
|
||||
このプロジェクトは、Strudel ライブコーディングの試行錯誤を記録するノートブックであり、Gemini CLI のカスタムスキルを活用して楽曲制作を加速させるための環境です。
|
||||
|
||||
⚠️ **注意**: このリポジトリは公開用です。個人情報や機密情報は絶対にアップロードしないでください。
|
||||
東京の電子音楽シーンの感性を持つ AI アシスタント「ボク」が、君の音楽制作を強力にサポートします。
|
||||
|
||||
## ファイル説明
|
||||
- `/notebook/gemini.md`: コードスタイルや公式URLのリファレンス
|
||||
- `/notebook/.gemini/reference.md`: gemini.mdから参照する詳細なstrudelの情報
|
||||
- `/notebook/.gemini/skills/strudel_fix_and_explain.md`: strudelコードの誤りの修正とコードの説明のためのskill
|
||||
- `/notebook/.gemini/skills/strudel_refactor.md`: strudelコードをより良いコードにするためのskill
|
||||
## 🚀 主な機能
|
||||
|
||||
## ディレクトリ構成
|
||||
### 1. テンプレート生成 (`generate-strudel-template`)
|
||||
指定したジャンル(Techno, House, Dub Techno, Hypnotic Techno など)に基づき、即座に演奏可能な Strudel コードと音楽的解説を生成します。
|
||||
生成されたファイルは `strudel/` ディレクトリに保存されます。
|
||||
|
||||
- `/notebook/strudel/`: 既存のStrudelコード(Markdown形式)
|
||||
- `/notebook/.gemini/`: Strudelの知識ベース(Markdown形式)
|
||||
- `/notebook/.gemini/skills/`: Gemini CLI用のスキル定義ファイル(プロンプトエンジニアリング)
|
||||
- `/notebook/script/`: スキルを実行するための各種シェルスクリプト
|
||||
- `/notebook/refactoring/`: リファクタリング後のコード出力先(実行時に自動生成)
|
||||
- `/notebook/explained/`: 解説・修正後のコード出力先(実行時に自動生成)
|
||||
### 2. 構文修正 & 解説 (`fix-and-explain-strudelcode`)
|
||||
君が書いた Strudel コードのエラー(`~` の誤用など)を最小限の修正で解決し、楽曲の音楽的な意図をプロの視点から解説します。
|
||||
修正版は `explained/` ディレクトリに保存され、オリジナルのファイルは保護されます。
|
||||
|
||||
## 主な機能
|
||||
## 📁 ディレクトリ構成
|
||||
|
||||
1. **コード解説と修正**: `fix_and_explain_strudel.sh` を使用して、コードのバグ修正と詳細な解説を生成します。
|
||||
2. **リファクタリング**: `refactor_strudel.sh` を使用して、より洗練されたStrudelコードへの書き換えを行います。
|
||||
- `strudel/`: 楽曲のアイディアや生成されたテンプレート(Markdown)
|
||||
- `explained/`: AI によって修正・解説された楽曲データ
|
||||
- `.gemini/skills/`: Gemini CLI 用のカスタムスキル定義
|
||||
- `.gemini/REFERENCE.md`: Strudel の最新構文や音源のリファレンス
|
||||
- `script/`: バッチ処理用のユーティリティスクリプト
|
||||
|
||||
## ワークフロー
|
||||
## 🛠 使い方
|
||||
|
||||
プロジェクトのルートディレクトリ(`/notebook/`)から、対象に合わせて以下のコマンドを実行します。
|
||||
|
||||
### 1. 全ファイルを一括で修正・解説する
|
||||
`strudel/` フォルダ内のすべての `.md` ファイルを処理します。
|
||||
### スキルの有効化
|
||||
このプロジェクトを初めて使用する場合や、スキルを更新した後は以下のコマンドを実行してください。
|
||||
```bash
|
||||
bash script/fix_and_explain_strudel.sh
|
||||
gemini skills reload
|
||||
```
|
||||
|
||||
### 2. 特定のファイルにリファクタリングを適用する
|
||||
個別のファイルを指定して実行することも可能です。
|
||||
```bash
|
||||
bash script/refactor_strudel.sh strudel/my-beat.md
|
||||
```
|
||||
### テンプレートの生成
|
||||
Gemini CLI に対して、作りたいジャンルを伝えてください。
|
||||
> "Dub Techno のテンプレートを生成して"
|
||||
|
||||
実行後、結果は `refactoring/` や `explained/` フォルダに自動的に保存されます。
|
||||
### コードのデバッグ
|
||||
作成中のコードに問題がある場合や、プロの解説が欲しい場合に依頼してください。
|
||||
> "strudel/my_beat.md のエラーを直して解説して"
|
||||
|
||||
## 🎵 制作のポリシー
|
||||
- **Initialization**: すべてのコードは `setcps(BPM/60/4)` で開始します。
|
||||
- **Modular Control**: 各トラックは `$: ` 記法で独立して制御します。
|
||||
- **Clean Syntax**: 休符には `-` を使い、可読性の高いコードを目指します。
|
||||
|
||||
---
|
||||
Happy Live Coding! 🎛️✨
|
||||
|
||||
Reference in New Issue
Block a user