Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
kmturley committed Nov 22, 2020
1 parent b4cc013 commit e5d2646
Showing 5 changed files with 42 additions and 40 deletions.
14 changes: 6 additions & 8 deletions _docs/02-create-a-project-config.md
Original file line number Diff line number Diff line change
@@ -9,14 +9,12 @@ If music project folder does not contain a project.json, you can create a new on
This will create a project.json with your configuration:

{
"name": "Example audio project",
"version": "1.0.0",
"description": "Example audio project description",
"main": "Test.als",
"preview": {
"audio": "Test.wav",
"image": "Test.png"
},
"name": "My Project",
"version": "0.0.1",
"description": "My project description",
"main": "Song.als",
"audio": "Song.wav",
"image": "Song.png",
"plugins": {
"plugin-name": "1.0.0"
}
4 changes: 2 additions & 2 deletions _docs/03-add-remove-plugins.md
Original file line number Diff line number Diff line change
@@ -8,10 +8,10 @@ Search the plugin registry using:

Add a plugin and update project.json config using:

studiorack install kmturley/studiorack-plugin --global
studiorack install studiorack/studiorack-plugin/adelay --global

Remove a plugin and update project.json config using:

studiorack uninstall kmturley/studiorack-plugin --global
studiorack uninstall studiorack/studiorack-plugin/adelay --global

[Launch project config >](/docs/04-launch-project-config)
2 changes: 2 additions & 0 deletions _docs/04-launch-project-config.md
Original file line number Diff line number Diff line change
@@ -9,3 +9,5 @@ Navigate to a music project folder containing a project.json config, install all
Then start the project using

studiorack start

[Read the API Reference >](/docs/06-command-line)
10 changes: 7 additions & 3 deletions _docs/05-develop-new-plugins.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ Create a new plugin using the starter template:

This creates a new plugin using the starter template with the following structure:

/folder
/myplugin
/index.js
/LICENSE
/README.md
@@ -19,8 +19,12 @@ This creates a new plugin using the starter template with the following structur

Follow the instructions at ./myplugin/README.md to install and build your plugin

When ready to release, commit your plugin to Github and then run:
When ready to release, commit your plugin to Github and then:

1. Publish a Github release containing the plugin source along with metadata `plugins.json`
2. Tag your Github repository with `studiorack-plugin` so it can be discovered
3. Wait for the studiorack-registry to index your plugin (every 24 hours)
4. Check the registry feed for your plugin to appear https://studiorack.github.io/studiorack-registry/

studiorack publish

[Read the API Reference >](/docs/06-command-line)
52 changes: 25 additions & 27 deletions _docs/06-command-line.md
Original file line number Diff line number Diff line change
@@ -8,9 +8,9 @@ The StudioRack CLI allows you to create, install, and publish plugins.
* [Init](#init)
* [Install](#install)
* [Uninstall](#uninstall)
* [Publish](#publish)
* [Search](#search)
* [Start](#start)
* [Validate](#validate)
* [Help](#help)


@@ -34,14 +34,12 @@ Follow the instructions in generated README.md to install and build your plugin.
`studiorack init` initiates the current folder as a studiorack project. This will create a project.json with your configuration:

{
"name": "Example audio project",
"version": "1.0.0",
"description": "Example audio project description",
"main": "Test.als",
"preview": {
"audio": "Test.wav",
"image": "Test.png"
},
"name": "My Project",
"version": "0.0.1",
"description": "My project description",
"main": "Song.als",
"audio": "Song.wav",
"image": "Song.png",
"plugins": {
"plugin-name": "1.0.0"
}
@@ -52,26 +50,19 @@ Follow the instructions in generated README.md to install and build your plugin.

`studiorack install [options] [id]` adds a plugin and updates the project.json config. For example:

studiorack install kmturley/studiorack-plugin --global
studiorack install studiorack/studiorack-plugin/adelay --global


## Uninstall

`studiorack uninstall [options] [id]` removes a plugin and updates the project.json config. For example:

studiorack uninstall kmturley/studiorack-plugin --global


## Publish

`studiorack publish` opens a pull request to the main GitHub registry. For example:

studiorack publish
studiorack uninstall studiorack/studiorack-plugin/adelay --global


## Search

`studiorack search <query>` search the plugin registry for plugins by name. For example:
`studiorack search [options] <query>` Search plugin registry by query. For example:

studiorack search delay

@@ -83,6 +74,13 @@ Follow the instructions in generated README.md to install and build your plugin.
studiorack start


## Validate

`studiorack validate [options] [path]` Validate a plugin using the Steinberg VST3 SDK validator. For example:

studiorack validate ./plugins/**/*.vst3


## Help

`studiorack --help` lists the available CLI commands which looks like this:
@@ -95,11 +93,11 @@ Follow the instructions in generated README.md to install and build your plugin.
-h, --help display help for command

Commands:
create <folder> Create a new folder using the plugin starter template
init Set up a new or existing StudioRack project.
install [options] [id] Install a plugin and update project config.
uninstall [options] [id] Uninstall a plugin and update project config.
publish Publish plugin to the registry
search <query> Search plugin registry by query.
start [path] Start music project using the project config.
help [command] display help for command
create <folder> Create a new folder using the plugin starter template
init Set up a new or existing StudioRack project.
install [options] [id] Install a plugin and update project config.
uninstall [options] [id] Uninstall a plugin and update project config.
search [options] <query> Search plugin registry by query.
start [path] Start music project using the project config.
validate [options] [path] Validate a plugin using the Steinberg VST3 SDK validator
help [command] display help for command

0 comments on commit e5d2646

Please sign in to comment.