Browse Source

Update Manifests license property.

pull/46/head
Andrew Belt 4 years ago
parent
commit
9394f0fc78
3 changed files with 10 additions and 7 deletions
  1. +3
    -2
      FAQ.md
  2. +5
    -2
      Manifest.md
  3. +2
    -3
      README.md

+ 3
- 2
FAQ.md View File

@@ -5,6 +5,7 @@

There is no official meaning of the name "VCV", but users have suggested "Virtual Control Voltage" or "Voltage Controlled Virtualization".
These are good guesses, but "VCV" was chosen simply because it is easy to remember and type.
"VCV Rack" is the full name of our flagship software product.


<a id="userfolder"></a>
@@ -21,9 +22,9 @@ When running Rack in development mode, it is your current working directory inst


<a id="plugin"></a>
## I know what modules are, but what is a VCV Rack plugin?
## What is a VCV Rack plugin?

A plugin is a single unit of software loaded by VCV Rack that can contain multiple modules.
A plugin is a single software unit typically developed by one company or individual that can contain multiple VCV Rack modules.
Plugins are loaded from `<Rack user folder>/plugins-v*`.

When Rack v2 is released, you will be able to add individual modules to your personal module library, rather than entire plugins, so the concept of a "plugin" will soon be hidden from end users and exposed only to developers.


+ 5
- 2
Manifest.md View File

@@ -41,9 +41,12 @@ If you publish the source code in a git repository, it is recommended to add a g
*String. Required.*

The license of your plugin.
Use `"proprietary"` for commercial and freeware plugins.

If your plugin uses a common open-source license, use the identifier string from the [SPDX License List](https://spdx.org/licenses/), such as `GPL-3.0-or-later`, `GPL-3.0-only`, `MIT`, `BSD-3-Clause`, `CC0-1.0`, etc.
For open-source plugins, use the license identifier string from the [SPDX License List](https://spdx.org/licenses/), such as `GPL-3.0-or-later`, `GPL-3.0-only`, `MIT`, `BSD-3-Clause`, `CC0-1.0`, etc.

For freeware plugins, use `proprietary` (TODO: use `https://vcvrack.com/freeware-eula` when available) or your own freeware license URL.

For commercial plugins, use `https://vcvrack.com/eula` if sold on the VCV Library or your own commercial license URL.

## `.brand`
*String. Optional.*


+ 2
- 3
README.md View File

@@ -10,10 +10,9 @@ Your PR will be accepted if it is a net positive benefit to readers.

## Building

Install [Sphinx](http://www.sphinx-doc.org/en/stable/).
Install [Sphinx](http://www.sphinx-doc.org/en/stable/) and the [readthedocs theme](https://github.com/readthedocs/sphinx_rtd_theme).

pip install sphinx
pip install sphinx_rtd_theme
pip install sphinx sphinx_rtd_theme

Install [recommonmark](https://github.com/rtfd/recommonmark).



Loading…
Cancel
Save