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 a28c0aa93f Remove .html from URLs to the manual. 4 years ago
images Add GettingStarted and KeyCommands articles. Add a few FAQ entries. Various revisions to other articles. 4 years ago
.gitignore Migrate from GitBook to Sphinx 6 years ago
.gitmodules Migrate from GitBook to Sphinx 6 years ago
About.md Remove .html from URLs to the manual. 4 years ago
Building.md Update last month of manual changes. 4 years ago
Communities.md Add GettingStarted and KeyCommands articles. Add a few FAQ entries. Various revisions to other articles. 4 years ago
Core.md Remove .html from URLs to the manual. 4 years ago
DSP.md Change formula delimiter to $ and $$. 4 years ago
FAQ.md Remove .html from URLs to the manual. 4 years ago
GettingStarted.md Remove .html from URLs to the manual. 4 years ago
Installing.md Remove .html from URLs to the manual. 4 years ago
Issues.md Add GettingStarted and KeyCommands articles. Add a few FAQ entries. Various revisions to other articles. 4 years ago
KeyCommands.md Remove .html from URLs to the manual. 4 years ago
Manifest.md Remove .html from URLs to the manual. 4 years ago
MenuBar.md Remove .html from URLs to the manual. 4 years ago
Migrate1.md Remove Bridge page. Add Issues page. Fix Sphinx version in README. 5 years ago
Migrate2.md Update last month of manual changes. 4 years ago
Panel.md Remove .html from URLs to the manual. 4 years ago
PluginDevelopmentTutorial.md Remove .html from URLs to the manual. 4 years ago
PluginLicensing.md Add Polyphony article. Add performance section to FAQ. Lots of language tweaks. 4 years ago
Polyphony.md Remove .html from URLs to the manual. 4 years ago
README.md Update Manifests license property. 4 years ago
Version.md Add Polyphony article. Add performance section to FAQ. Lots of language tweaks. 4 years ago
VoltageStandards.md Use $ and $$ delimiters for formulas in Polyphony and VoltageStandards. 4 years ago
index.md Remove Sphinx stuff. Add index and toc articles. 4 years ago
toc.md Remove Sphinx stuff. Add index and toc articles. 4 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 and the readthedocs theme.

pip install sphinx sphinx_rtd_theme

Install recommonmark.

pip install recommonmark

Build with

make html

The output should be generated in _build/html.

License

All documentation text in this repository is licensed under CC BY-SA 4.0.

Images such as screenshots and logos are licensed by their respective owner.