aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 426ede3..3240ac8 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-# csound-template : template for Csound plugins
+# csound-shout : Csound plugin for streaming to Shoutcast, Icecast and other compatible servers
## Overview
-Description here
+csound-shout enables simple connection to a Shoutcast or Icecast server (or anything else supporting the shout protocol), and streaming audio to the server from within Csound.
+Audio is encoded as VBR MP3, and various stream descriptors/metadata may be set.
## Requirements
* Cmake >= 2.8.12
* Csound with development headers >= 6.14.0
-
## Installation
Create a build directory at the top of the source tree, execute *cmake ..*, *make* and optionally *make install* as root. If the latter is not used/possible then the resulting library can be used with the *--opcode-lib* flag in Csound.
eg: