Read Me

The Newtonator
==============

The Newtonator is an LV2 soft synth that uses a unique algorithm based on
simple ideas of velocity and acceleration to produce some unpredictable
sounds. More documentation can be found on the project website at
http://newtonator.sf.net/.

To build and install, you will need cmake installed on your system. Once
installed, create a new directory for your build (preferably at the root
project directory), change to it, then run cmake against the root
directory of the project. For example, from the "newtonator-X.X.X"
directory:

mkdir build
cd build
cmake ..

That's it. The configuration step will let you know if you are missing any
dependencies; if everything is in place, the necessary files to build the
project will be generated (Makefiles on Linux) in the current directory,
so you'll then need to run:

make

...from your build directory in order to actually compile the code, and a
subsequent "make install" to install the LV2 plugin to the proper
folder(s). Note that there are some customizable variables that can be set
when running cmake that control the app's configuration and installation;
these can be viewed with "cmake -L" and are documented below:

INCLUDE_EXT_INPUTS - Specifies whether to compile the synth plugin with
external audio inputs defined for the gravity and floor modulation. Most
LV2 hosts don't like superfluous audio inputs on their synth plugins, so
to be safe, don't set this to TRUE. Defaults to FALSE.

PEG_COMMAND - How to invoke the lv2peg script that comes with the
lv2-c++-tool package (this tool is required). Defaults to "lv2peg".

LV2_INSTALL_DIR - The root directory to install LV2 plugins. For
user-specific installations, do "~/.lv2". Defaults to "lib/lv2" (this is
relative to cmake's default install root directory, which is usually
/usr/local)

Get help and submit bug reports here:
https://sourceforge.net/projects/newtonator/support