saus/README

33 lines
1004 B
Plaintext
Raw Permalink Normal View History

2019-03-19 10:49:13 +00:00
============
*** SAUS ***
============
2019-03-22 10:58:19 +00:00
Scripted AUdio Software is a command-line tool for real-time scripted
audio filtering via JACK audio inputs. The user writes scripts which
2019-03-19 10:49:13 +00:00
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
2019-03-22 10:58:19 +00:00
* GNU Readline
2019-03-19 10:49:13 +00:00
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.
2019-03-19 10:49:13 +00:00
## 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).