Browse Source

Add mission statement, remove glossary

pull/13/head
Andrew Belt 6 years ago
parent
commit
0592ec7b6a
6 changed files with 17 additions and 54 deletions
  1. +1
    -1
      Communities.md
  2. +5
    -5
      Core.md
  3. +0
    -38
      Glossary.md
  4. +8
    -7
      Installing.md
  5. +2
    -2
      Version.md
  6. +1
    -1
      index.rst

+ 1
- 1
Communities.md View File

@@ -17,5 +17,5 @@
- [Switched On Rack collaboration albums](https://switchedonrack.bandcamp.com/)
- [Reddit](https://www.reddit.com/r/vcvrack/)
- [Twitch](https://www.twitch.tv/communities/vcvrackcommunity)
- [Slack developers chat](https://vcvrackdevelopers.slack.com/join/shared_invite/enQtMzczNzY2NDUzMTczLWM2Mjg0ZjEzNDQ2YTEwYjFiZTA3MzE4NTRjMjg5ZjRkZDAwMDk5M2I4NmIzYmEyZGY1NGQ4YWE4NzkzZjlhMmI)
- [Slack developers chat](https://join.slack.com/t/vcvrackdevelopers/shared_invite/enQtMzczNzY2NDUzMTczLWM2Mjg0ZjEzNDQ2YTEwYjFiZTA3MzE4NTRjMjg5ZjRkZDAwMDk5M2I4NmIzYmEyZGY1NGQ4YWE4NzkzZjlhMmI)
- [IRC](http://webchat.freenode.net?channels=%23VCVRack)

+ 5
- 5
Core.md View File

@@ -19,11 +19,11 @@ The *Audio* module merges the virtual Rack world with the physical hardware worl
The **INPUT** section sends up to 8 Rack signals to a hardware audio device for playback, and the **OUTPUT** section sends up to 8 hardware signals into Rack.

*Audio* currently supports the following **drivers**.
- Core Audio on Mac
- WASAPI on Windows
- ASIO on Windows
- ALSA on Linux
- JACK on Linux
- [Core Audio](https://developer.apple.com/library/content/documentation/MusicAudio/Conceptual/CoreAudioOverview/WhatisCoreAudio/WhatisCoreAudio.html) on Mac
- [WASAPI](https://msdn.microsoft.com/en-us/library/windows/desktop/dd371455%28v=vs.85%29.aspx) on Windows
- [ASIO](https://en.wikipedia.org/wiki/Audio_Stream_Input/Output) on Windows
- [ALSA](http://alsa-project.org/main/index.php/Main_Page) on Linux
- [JACK](http://www.jackaudio.org/) on Linux
- [VCV Bridge](Bridge.html)

After a driver is selected, a particular **device** can be chosen for the driver.


+ 0
- 38
Glossary.md View File

@@ -1,38 +0,0 @@
# Glossary


## Core Audio

https://developer.apple.com/library/content/documentation/MusicAudio/Conceptual/CoreAudioOverview/WhatisCoreAudio/WhatisCoreAudio.html


## WASAPI

https://msdn.microsoft.com/en-us/library/windows/desktop/dd371455%28v=vs.85%29.aspx

## ASIO

Audio Stream Input/Output. A computer sound card driver protocol for digital audio specified by Steinberg, providing a low-latency and high fidelity interface between a software application and a computer's sound card.

https://en.wikipedia.org/wiki/Audio_Stream_Input/Output

## ALSA

Advanced Linux Sound Architecture.

http://alsa-project.org/main/index.php/Main_Page
https://en.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture

## JACK

JACK Audio Connection Kit. A sound and MIDI server and client with advanced routing capabilities.

http://www.jackaudio.org/

## API

Application Programming Interface.

## ABI

Application Binary Interface. The binary interface implemented by a library and used by an application.

+ 8
- 7
Installing.md View File

@@ -4,19 +4,19 @@

Download Rack on the [VCV Rack website](https://vcvrack.com/).

### Mac
### Installing on Mac

Open the DMG image and copy the Rack app to your Applications folder.

If you wish to use [VCV Bridge](Bridge.md), copy `VCV-Bridge.vst` to the VST folder and/or the `VCV-Bridge.component` Audio Unit to the Components folder.

### Windows
### Installing on Windows

Run the installer.

If you wish to use [VCV Bridge](Bridge.md), make sure the VST feature is checked for your architecture (32- or 64-bit) and specify the location to install it in the next few steps.

### Linux
### Installing on Linux

Unzip the zip file.

@@ -43,18 +43,19 @@ Note: Do not download the plugin via GitHub's green "Clone or download" button.

## Running Rack

### Mac
### Running on Mac

Launch Rack from the Applications folder or the dock.
On modern Mac versions, you may need to right click the application and click "Open" when launching for the first time.

### Windows
### Running on Windows

Click on Rack in the Start Menu.

### Linux
### Running on Linux

Double click the `Rack` binary or launch from the command line.
Double click the `Rack` binary.
Or with the command-line, `cd` into the `Rack` directory and run `./Rack`.

### Command line usage



+ 2
- 2
Version.md View File

@@ -1,7 +1,7 @@
# ABI/API Version

An ABI is a machine-readable list of symbols (functions, globals, and classes) that can only be called, accessed, and used in specific ways.
An API consists of C and C++ headers (`.h` and `.hpp` files) that define how the ABI can be used.
An ABI (Application Binary Interface) is a machine-readable list of symbols (functions, globals, and classes) that can only be called, accessed, and used in specific ways.
An API (Application Programming Interface) consists of C and C++ headers (`.h` and `.hpp` files) that define how the ABI can be used.

Rack plugins must be compiled against a particular *major version* of Rack to match its ABI, so that when Rack loads them, they link to Rack's symbols correctly.
The major version is `X` in the version name `vX.Y` (or `v0.X.Y` for beta versions).


+ 1
- 1
index.rst View File

@@ -39,4 +39,4 @@ Rack
:caption: Appendix

Communities.md
Glossary.md
About.md

Loading…
Cancel
Save