VCVRack
/
manual
mirror of https://github.com/VCVRack/manual.git
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
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.
82 Commits
1 Branch
19MB
Tree: 8b5ce97986
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '8b5ce97986'
${ noResults }
Andrew Belt 8b5ce97986 Add Panel Tutorial page. 6 years ago
_static Migrate from GitBook to Sphinx 6 years ago
images qwerty (#25) 6 years ago
.gitignore Migrate from GitBook to Sphinx 6 years ago
.gitmodules Migrate from GitBook to Sphinx 6 years ago
About.md Add jq to build deps. Reorganize community list. 6 years ago
Bridge.md Update Bridge.md (#22) 6 years ago
Building.md Add jq to build deps. Reorganize community list. 6 years ago
Communities.md Add jq to build deps. Reorganize community list. 6 years ago
Contributing.md Last few weeks of revisions 6 years ago
Core.md qwerty (#25) 6 years ago
DSP.md Update communities. Add Timing section to Voltage Standards. Add license for documentation text to README. 6 years ago
FAQ.md Add jq to build deps. Reorganize community list. 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 Expand Migrate1 document 6 years ago
PanelTutorial.md Add Panel Tutorial page. 6 years ago
PluginDevelopmentTutorial.md Update communities. Add Timing section to Voltage Standards. Add license for documentation text to README. 6 years ago
QuickStart.md Add Contributing page 7 years ago
README.md Update communities. Add Timing section to Voltage Standards. Add license for documentation text to README. 6 years ago
Toolbar.md Fix sphinx and recommonmark versions 6 years ago
Version.md Add mission statement, remove glossary 6 years ago
VoltageStandards.md Expand Migrate1 document 6 years ago
conf.py Fix sphinx and recommonmark versions 6 years ago
favicon.png Add jq to build deps. Reorganize community list. 6 years ago
index.rst Add Panel Tutorial page. 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 0.8.1. Newer versions do not generate formulas and image tags properly.

pip install sphinx==0.8.1

Install recommonmark 0.4.0.

pip install recommonmark==0.4.0

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.