aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index e7052a9..4a8fbf9 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,19 @@
-README
+# Vaud
-vaud is a simple audio vizualizer written in ncureses for JACK,
+## Overview
+Vaud is a simple audio vizualizer written in ncureses for JACK,
I wrote it because I could find no good alternative.
+Vaud is built on the work of [Nicholas J. Humfrey](njh@aelius.com) and [Steve Harris](steve@plugin.org.uk)
+
+## Installing
+### Dependencies
+You must have `libncurses-dev` and `jack-dev` installed
+### Building
+Compileing is just a straight forward `make`
+### Configuration
+You can modify config.h to change colors and some other stuff about how the visualizer displays. A recompile is needed for changes to take effect.
+
+## Usage
To use, you MUST have the JACK server running,
go under "connect" and connect vaud to whichever output you want.
-
-Additionally, color customization can be found in the config.h file.
-YOU NEED TO RECOMPILE FOR COLORS TO APPLY.