Skip to content

Commit

Permalink
User documentation link in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
VoidXH committed Jan 4, 2021
1 parent 7405af4 commit 5df9057
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 47 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@ Cavern is a fully adaptive object-based audio engine and upmixer without limitat
* Unity-like listener and source functionality
* Ultra low latency, even the upconverter can work from as low as one sample per frame

## Helpful documents
* [Calibration process](./docs/Calibration%20process.md) for traditional or Cavern-only rooms
* [Cavern DCP channel order](./docs/Cavern%20DCP%20channel%20order.md) compared to DCP standards
* [Limitless Audio Format](./docs/Limitless%20Audio%20Format.md) for storing Cavern mixes in a CPU-effective spatial format
* [Virtualizer repository](https://github.com/VoidXH/HRTF) which contains the raw IR measurements and detailed information about their use
## User documentation
User documentation can be found at the [Cavern documentation webpage](http://cavern.sbence.hu/cavern/doc.php).
Please go to this page for basic setup, in-depth QuickEQ tutorials, and
command-line arguments.

## How to build
### Cavern
Expand All @@ -31,6 +30,16 @@ the CavernUnity DLL project to UnityEngine and UnityEditor. Add these files from
your own Unity installation as references. They are found in Editor\Data\Managed
under Unity's installation folder.

### Cavernize Lite
This is a Code::Blocks project, set up for the MingW compiler. No additional
libraries were used, this is standard C++ code, so importing just the .cpp and
.h files into any IDE will work perfectly.

## Development documents
* [Cavern DCP channel order](./docs/Cavern%20DCP%20channel%20order.md) compared to DCP standards
* [Limitless Audio Format](./docs/Limitless%20Audio%20Format.md) for storing Cavern mixes in a CPU-effective spatial format
* [Virtualizer repository](https://github.com/VoidXH/HRTF) which contains the raw IR measurements and detailed information about their use

## Disclaimers
### Code
Cavern is a performance software written in an environment that's not ready for
Expand Down
42 changes: 0 additions & 42 deletions docs/Calibration process.md

This file was deleted.

0 comments on commit 5df9057

Please sign in to comment.