From 5db1a249140294e2f8a8a11abc0d0640f9f6dfb3 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 15 Feb 2017 13:18:58 -0500 Subject: Updated readme --- README.md | 19 ++++++++++++++----- README.md~ | 10 ---------- 2 files changed, 14 insertions(+), 15 deletions(-) delete mode 100644 README.md~ 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. diff --git a/README.md~ b/README.md~ deleted file mode 100644 index e7052a9..0000000 --- a/README.md~ +++ /dev/null @@ -1,10 +0,0 @@ -README - -vaud is a simple audio vizualizer written in ncureses for JACK, -I wrote it because I could find no good alternative. - -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. -- cgit v1.2.3-70-g09d2