README.md 1.1 KB
Newer Older
Michael Zbyszyński's avatar
Michael Zbyszyński committed
1
**RAPID-MIX API** is an easy-to-use toolkit designed to make sensor integration, machine learning and interactive audio accessible for artists, designers, makers, educators, and beginners, as well as creative companies and independent developers.
Michael Zbyszyński's avatar
Michael Zbyszyński committed
2

Michael Zbyszyński's avatar
Michael Zbyszyński committed
3
4
5
It has been built with RAPID-MIX technologies, that make it easy to combine sensor data, machine learning algorithms and interactive audio. They provide a full set of functionalities for cross-device and cross-platform development, modular components, and cloud-based services and multimodal data storage.

## Dependencies
6
Use `git submodule update --init --recursive` to pull the following library dependencies.  
Michael Zbyszyński's avatar
Michael Zbyszyński committed
7
1. RapidLib
8
9
10
11
1. XMM
1. PiPo
1. GVF
1. RepoVizz2 Client
Michael Zbyszyński's avatar
Michael Zbyszyński committed
12

Michael Zbyszyński's avatar
Michael Zbyszyński committed
13
## Documentation
14
Full documentation at http://www.rapidmixapi.com/
Michael Zbyszyński's avatar
Michael Zbyszyński committed
15
16


Michael Zbyszyński's avatar
Michael Zbyszyński committed
17
## Testing   
James Frink's avatar
James Frink committed
18
We are using Catch for C++ testing. Look at the test fixtures in the /tests/test_projetc/test_project.xcodeproj for an example of how to implement them.
Michael Zbyszyński's avatar
Michael Zbyszyński committed
19
20

## Building with CMake
Michael Zbyszyński's avatar
Michael Zbyszyński committed
21
Navigate to /RAPID-MIX_API and run this in a terminal:
Michael Zbyszyński's avatar
Michael Zbyszyński committed
22

Michael Zbyszyński's avatar
Michael Zbyszyński committed
23
24
25
26
27
`mkdir build  
cd build  
cmake ..  
make  
`
28
29

Or run the shell script: `./rmix_build_test.sh`