You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Andrew Belt 25541fcb7f Last few weeks of revisions 6 years ago
_static Migrate from GitBook to Sphinx 6 years ago
images Tweaks 6 years ago
.gitignore Migrate from GitBook to Sphinx 6 years ago
.gitmodules Migrate from GitBook to Sphinx 6 years ago
About.md Tweak grammar 6 years ago
Bridge.md Update Bridge.md (#22) 6 years ago
Building.md Add Building instructions 6 years ago
Communities.md Last few weeks of revisions 6 years ago
Contributing.md Last few weeks of revisions 6 years ago
Core.md Add mission statement, remove glossary 6 years ago
DSP.md Last few weeks of revisions 6 years ago
FAQ.md Last few weeks of revisions 6 years ago
Installing.md Link to VCV Bridge is wrong (#14) 6 years ago
Makefile Fix headers, add Optimization section to DSP page, expand Installing page 6 years ago
Migrate1.md Last few weeks of revisions 6 years ago
PluginDevelopmentTutorial.md Update link to Rack-SDK to latest version 0.6.2. (#18) 6 years ago
QuickStart.md Add Contributing page 7 years ago
README.md Fix headers, add Optimization section to DSP page, expand Installing page 6 years ago
Toolbar.md Last few weeks of revisions 6 years ago
Version.md Add mission statement, remove glossary 6 years ago
VoltageStandards.md Tweak grammar 6 years ago
conf.py Last few weeks of revisions 6 years ago
favicon.png Last few weeks of revisions 6 years ago
index.rst Add building instructions 6 years ago

README.md

VCV Rack 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.

Contributions

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.

Building

Install Sphinx.

Build with

make html

The output should be generated in _build/html.