Go to file
Nicolás Ortega Froysa 0d800746cd Added dependency information on checkdeps.sh 2019-03-25 20:29:22 +01:00
src Do not need extra args_doc. 2019-03-25 19:25:20 +01:00
.gitignore Initial commit. 2019-03-19 11:49:13 +01:00
LICENSE Initial commit. 2019-03-19 11:49:13 +01:00
Makefile Added basic JACK funcitonality. 2019-03-25 10:24:56 +01:00
README Added dependency information on checkdeps.sh 2019-03-25 20:29:22 +01:00
checkdeps.sh Script to check main dependencies. 2019-03-22 23:42:17 +01:00

README

============
*** SAUS ***
============
Scripted AUdio Software is a command-line tool for real-time scripted
audio filtering via JACK audio inputs. The user writes scripts which
modify the frequency and amplitude of the sound waves coming from the
JACK input.

# Building
----------
## Dependencies
To build the project you will require the following dependencies:
  * GNU Make
  * C99 compatible compiler
  * JACK2
  * GNU Readline

There exists a `checkdeps.sh' script that can be used to check if you
have all the dependencies installed, although it is not fully
functional.

## Compiling
To compile the project simply run the `make' command in the root
directory of the project. By default this will create a release build
with compiler optimizations. To compile with debug flags append
`DEBUG=1' to the `make' command.

# License
---------
This project is licensed under the terms & conditions of the GNU Affero
General Public License version 3 or greater (see `LICENSE' file for more
information).