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.
Xavier Shay
bc68e58e32
|
5 years ago | |
|---|---|---|
| _static | 5 years ago | |
| images | 5 years ago | |
| .gitignore | 6 years ago | |
| .gitmodules | 6 years ago | |
| About.md | 6 years ago | |
| Bridge.md | 5 years ago | |
| Building.md | 5 years ago | |
| Communities.md | 6 years ago | |
| Core.md | 6 years ago | |
| DSP.md | 6 years ago | |
| FAQ.md | 5 years ago | |
| Installing.md | 5 years ago | |
| Makefile | 6 years ago | |
| MenuBar.md | 5 years ago | |
| Metadata.md | 5 years ago | |
| Migrate1.md | 5 years ago | |
| Panel.md | 5 years ago | |
| PluginDevelopmentTutorial.md | 5 years ago | |
| PluginLicensing.md | 5 years ago | |
| QuickStart.md | 6 years ago | |
| README.md | 6 years ago | |
| Version.md | 6 years ago | |
| VoltageStandards.md | 5 years ago | |
| conf.py | 6 years ago | |
| favicon.png | 6 years ago | |
| index.rst | 5 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.