[beast: 17/23] README.md: update descriptions and add CI button
- From: Tim Janik <timj src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [beast: 17/23] README.md: update descriptions and add CI button
- Date: Wed, 14 Oct 2015 07:00:50 +0000 (UTC)
commit 747896cfb0a4cdab8ea1760937997aa61e8cba2c
Author: Tim Janik <timj gnu org>
Date: Fri Oct 9 01:36:11 2015 +0200
README.md: update descriptions and add CI button
Signed-off-by: Tim Janik <timj gnu org>
README.md | 54 +++++++++++++++++++++++++++++++-----------------------
1 files changed, 31 insertions(+), 23 deletions(-)
---
diff --git a/README.md b/README.md
index 6ec7fcc..c37a59d 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,50 @@
BEAST & BSE
===========
-This is the development version of Beast & Bse. BEAST is the BSE
-Equipped Audio Synthesizer and Tracker, and BSE is the Beast Sound Engine.
-Beast is a music composition and modular synthesis application, that is
-released as Free Software under the GNU LGPL and runs under Unix.
+[![Build Status](https://travis-ci.org/tim-janik/rapicorn.svg)](https://travis-ci.org/tim-janik/rapicorn)
+[![License
MPL2](http://testbit.eu/~timj/pics/license-lgpl-3.svg)](https://github.com/tim-janik/beast/blob/master/COPYING)
+
+
+# DESCRIPTION
+
+Beast is a digital synthesizer and music creation system. It has support
+for Linux Audio Plugins
+([LADSPA](http://wikipedia.org/wiki/LADSPA)),
+multitrack editing, unlimited undo, real-time synthesis, MIDI and various
+free audio codecs.
+
+* For a full description, visit the project page:
+ http://beast.testbit.eu
+
+* To submit bug reports and feature requests, visit:
+ https://github.com/tim-janik/beast/issues
+
+
+# REQUIREMENTS
Beast is a soft realtime application which needs elevated CPU scheduling
priorities to avoid audio glitches and drop outs. For this purpose, it
installs a small uid wrapper which acquires nice level -20 for the
synthesis threads and then immediately drops privileges.
For Linux kernels of the 2.6.x series and later, this enables the
-low-latency scheduling behavior needed to avoid audio artefacts,
-this kernel series is therefore recommended for operating Beast.
+low-latency scheduling behavior needed to avoid audio artefacts.
-In order to build release tarballs, Rapicorn, the GnomeCanvas,
-Guile, the Ogg/Vorbis Codec libraries and libflac are required.
-Support for MP3 files is optional and requires libmad (MPEG audio
+In order to build release tarballs, `Rapicorn`, `GnomeCanvas`,
+`Guile-1.8`, `Ogg/Vorbis` and `libflac` are required.
+Support for MP3 files is optional and requires `libmad` (MPEG audio
decoder library) when compiling Beast.
-The web site, download and forums for Beast are:
- http://beast.testbit.eu/
- http://beast.testbit.eu/beast-ftp/
- http://mail.gnome.org/mailman/listinfo/beast/ (beast gnome org)
- #beast on GimpNet (irc.gimp.org:6666)
-Beast also supports the LADSPA plugin API, so various kinds of third
-party plugins can be loaded and executed by Beast. LADSPA plugins are
-available from:
- http://www.ladspa.org
-Beast will look for LADSPA plugins under lib/ladspa/ inside it's own
-installation prefix, and in the directories listed in $LADSPA_PATH.
+# INSTALLATION
+In short, Beast needs to be built and installed with:
-Installation
-============
+ ./configure
+ make
+ make check # run simple unit tests
+ make install
+ make installcheck # run audio tests
Note that Beast has to be fully installed to function properly, and that
the binaries built in the launchers/ directory have to be installed with
permissions of the root user.
-For generic installation instructions, see the file 'INSTALL'.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]