aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard <q@1bpm.net>2025-03-09 22:41:23 +0000
committerRichard <q@1bpm.net>2025-03-09 22:41:23 +0000
commitdcf243e0899f0d63b9af13c36729a12eafacc211 (patch)
tree7801e34d43db7c7a85fdf5e91218b24ac25ed8c5
parent212bcc23589c06b4eff3cce510d7951210225b83 (diff)
downloadcsound-shout-dcf243e0899f0d63b9af13c36729a12eafacc211.tar.gz
csound-shout-dcf243e0899f0d63b9af13c36729a12eafacc211.tar.bz2
csound-shout-dcf243e0899f0d63b9af13c36729a12eafacc211.zip
README alterations
-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: