diff --git a/DSP.md b/DSP.md index da85aa7..4d30cf5 100644 --- a/DSP.md +++ b/DSP.md @@ -1,4 +1,4 @@ -# DSP +# Digital Signal Processing Digital signal processing (DSP) is the field of mathematics and programming regarding the discretization of continuous signals in time and space. One of its many applications is to generate and process audio from virtual/digital modular synthesizers. diff --git a/README.md b/README.md index 855ae7d..b8806d5 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,35 @@ -# VCV Rack Manual +# VCV Manual -The scope of the manual is the VCV Rack application. It does not include individual plugins for Rack---those should be documented and hosted by the plugin developer. +Markdown source repo for https://manual.vcvrack.com/ -## Contributions +## Contributing -Send a pull request to this repository with your edits. -Major changes like new pages and complete overhauls are welcome, as well as minor fixes like grammar, spelling, and reorganization. -Your PR will be accepted if it is a net positive benefit to readers. +This repo is like a wiki, but you must send a quality pull request to gain direct push access. +Fork this repo, make a quality improvement, and open a pull request. +If I accept it, I will add you as a repo maintainer so you can push to `master` directly. +manual.vcvrack.com is updated immediately after `master` is updated. -## Building +You can add images to the manual if they are necessary for your article. +Embed images with a relative link: +```md +![alt text](my-image.png) +``` -Install [Sphinx](http://www.sphinx-doc.org/en/stable/) and the [readthedocs theme](https://github.com/readthedocs/sphinx_rtd_theme). +You can use HTML in your Markdown if it is absolutely necessary, e.g. to embed a video. +If you abuse this feature, your maintainer privilege will be removed. - pip install sphinx sphinx_rtd_theme +## Hosting your plugin's manual -Install [recommonmark](https://github.com/rtfd/recommonmark). - - pip install recommonmark - -Build with - - make html - -The output should be generated in `_build/html`. +Fork this repo and add a folder matching your slug. +Add a single link to your plugin's main page to [toc.md](toc.md). +Example folder structure: +- `/Core/index`: Hosted at https://manual.vcvrack.com/Core/ +- `/Core/MIDI-CV`: Hosted at https://manual.vcvrack.com/Core/MIDI-CV +- `/Core/MIDI-CV.png`: Hosted at https://manual.vcvrack.com/Core/MIDI-CV.png ## License All documentation text in this repository is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). +Contributers agree to license their text contributions under this license. Images such as screenshots and logos are licensed by their respective owner. diff --git a/toc.md b/toc.md index 84bb9bc..7c89c3c 100644 --- a/toc.md +++ b/toc.md @@ -13,8 +13,8 @@ - [Panel](/Panel) - [Manifest](/Manifest) - [Voltage Standards](/VoltageStandards) - - [DSP](/DSP) - - [Migrate v1](/Migrate1) + - [Digital Signal Processing](/DSP) + - [Migrating v0.6 Plugins to v1](/Migrate1) - [Plugin Licensing](/PluginLicensing) - Rack Development