summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorterminator356 <termtech@rogers.com>2014-01-07 02:20:56 -0500
committerterminator356 <termtech@rogers.com>2014-01-07 02:20:56 -0500
commit2db4eaa626cb17584585ae070ec8fdedcf986a41 (patch)
tree4b2a0a99102435bcd5cfd9c1bd8c6a40c381a04c /README
parent7a6952bbdbcf8bd6573543d1c28e6fa75d50d4e4 (diff)
Move READMEs etc back into muse2, create README link.
Diffstat (limited to 'README')
l---------[-rw-r--r--]README262
1 files changed, 1 insertions, 261 deletions
diff --git a/README b/README
index e7fe89e9..7ab8d387 100644..120000
--- a/README
+++ b/README
@@ -1,261 +1 @@
-====================================================================
- MusE --- Linux Music Editor
-====================================================================
-
-Welcome to MusE, the open source MIDI/Audio sequencer.
-
-MusE is distributed under the GNU General Public License (GPL).
-Please check out the file COPYING in the muse2/ directory for more
-details.
-
-
- =============================
- Features:
- =============================
-
- MIDI sequencing:
- - Realtime record/playback
- - Midi file import/export
- - Input filter
- - Support for internal softsynth plugins using
- DSSI, VST and MESS
- - much more
-
- Audio sequencing:
- - Realtime Record/Playback several mono/stereo inputs/outputs
- - Graphical editing of automation
- - Support for LADSPA, DSSI, VST plugins
-
- Technologies supported:
- - LASH - for session control with external LASH enabled applications
- - JACK - The Jack Audio Connection Kit can be used for audio and midi
- - ALSA midi output
- - Plugin formats: DSSI, VST(i), MESS
- - FLAM plugin guis.
- - Built on QT4
-
-
-
-
-,-----------------------------------------------------------------.
-| NOTICE |
-|-----------------------------------------------------------------|
-| Some parts of MusE code are EXPERIMENTAL, and may well result |
-| in a CRASH, and who knows what other ill effects. |
-| RUN THIS SOFTWARE AT YOUR OWN RISK. |
-`-----------------------------------------------------------------'
-
- =============================
- Requirements:
- =============================
-
- - CMake >= 2.4
- http:/www.cmake.org/HTML/Download.html
-
- - QT: Qt >= 4.2.0 (development files)
- http://qt.nokia.com/products/
- MusE does _not_ compile with older versions
-
- - gcc >= 4.x.x or clang >= 2.9
- http://gcc.gnu.org/
- http://clang.llvm.org/
-
- - libsndfile >= 1.0.1 (development files)
- http://www.mega-nerd.com/libsndfile/
-
- - libsamplerate >= 0.1.0 (development files)
- http://www.mega-nerd.com/SRC/
-
- - JACK >= 0.103 (development files)
- http://jackaudio.org/
-
- - libuuid (development files)
- e2fsprogs package http://e2fsprogs.sourceforge.net/
- Some distros may include it in another package such as 'libuuid', or offer a choice.
-
- - LADSPA (development file ladspa.h)
- www.ladspa.org
-
- =============================
- Optional:
- =============================
-
- - fluidsynth >= 1.0.3 (formerly known as iiwusynth) (development files)
- http://sourceforge.net/apps/trac/fluidsynth/
-
- - liblo Lightweight OSC (Open Sound Control) (development files)
- http://liblo.sourceforge.net/
- - DSSI Disposable Soft Synth Interface (development files)
- http://dssi.sourceforge.net/
- (Both recommended - DSSI alone will have no native GUIs, OSC alone does nothing, for now.)
-
- - dssi-vst Support for DSSI vst plugins
- http://www.breakfastquay.com/dssi-vst/
-
- - LASH Audio Session Handler
- http://lash.nongnu.org/
- Recently LADISH has been emulating it instead:
- http://ladish.org/
-
- - Python The python scripting language
- http://www.python.org
- Python support is required for some experimental features.
- Currently it's NOT recommended to build with python support.
-
- =============================
- Building MusE:
- =============================
-
- - Download source from http://lmuse.sourceforge.net/
-
- - Unpack the source somewhere.
-
- You may also try the various MusE development SVN branches for
- up-to-the-minute features and fixes, but they may be less stable.
-
- - To compile MusE, run the following commands from the
- top level directory where the source code was unpacked
- (the directory where THIS README FILE is found):
-
- ******************************************************
- * Notice: *
- * A quick way is to run the ./compile_muse.sh *
- * script in the same dir, it should perform the same *
- * steps for a basic setup without asking any *
- * questions. If it fails you may be better off using *
- * the instructions below. *
- ******************************************************
-
- The build directory:
- --------------------
- Building in a subdirectory is recommended to keep the build directory separate from the source tree.
- So create a new subdirectory with a useful name like "build" or "debug" or "release":
- mkdir build
- Change directory (cd) to the new directory:
- cd build
-
- Configuration:
- --------------
- There are a few different ways to configure (notice the two dots):
-
- Type "cmake -i .." to run in step-by-step 'Wizard' mode, this is the RECOMMENDED way to
- setup the build environment.
-
- Or type "cmake -L .." to see options, then compose "cmake <options>" yourself.
- Some <options> are:
-
- -DCMAKE_BUILD_TYPE=<type>
- <type> can be blank (to reset a previous cached type to 'empty'),
- debug, release, RelWithDebInfo and MinSizeRel.
- Release is recommended, to get optimizations.
- If no CMAKE_BUILD_TYPE is given at all, cmake uses either the previous
- cached value, or else 'empty' (plain or default system optimizations).
-
- -DCMAKE_INSTALL_PREFIX=<prefix>
- The installation <prefix> where the program is installed.
- The default is to install in /usr/local.
-
- Or type "ccmake .." (if you have it - text-mode GUI). It may be blank so hit
- 'C' to first-time configure. Fiddle with yer options if ye so desire, then hit
- 'C' to configure then 'G' to generate and exit, or 'Q' to quit without
- generating.
-
- Or there is also a desktop GUI for cmake called cmake-gui.
-
- Compiling:
- ----------
- After configuration, while still in the build directory,type:
- make
-
- Installing:
- ----------
- After compiling, type:
- make install (as root)
- or
- sudo make install
-
- =============================
- Running MusE:
- =============================
-
- Recommended setup:
- ------------------
- MusE is a realtime program which requires special rights to work properly.
-
- - Check if you are running a sufficiently new linux kernel > 2.6.x
- A modern, standard destop kernel might suit your needs.
- However, for the best performance a so-called 'low latency' or 'realtime'
- kernel may be required. Check your distro's packages for availability.
-
- - create an "audio" group if it does not already exists
- and put yourself into this group
-
- - For realtime priority, you may want to ensure either the file:
- /etc/security/limits.conf
- or
- /etc/security/limits.d/audio.conf
- contains:
- @audio - rtprio 95
- @audio - memlock unlimited
-
- - make sure you can acces the realtime clock (RTC)
- chmod 660 /dev/rtc
- chgrp audio /dev/rtc
-
- - make sure MusE can set the rtc clock:
- echo 8192 > /proc/sys/dev/rtc/max-user-freq
- inspect with:
- cat /proc/sys/dev/rtc/max-user-freq
-
- - some distros do not load the alsa sequencer module by default.
- if necessary, load the alsa sequencer module with:
- /sbin/modprobe snd-seq
-
- - Start jack, typically by using the qjackctl application.
- MusE can also be run without Jack. MusE will use a dummy audio
- driver if Jack is not detected, or the -a option is given.
-
-
- Running:
- ------------------
- start MusE by typing:
- muse2 <options>
-
- Some <options> are:
- -h help
- -v print version
- -d debug mode: no threads, no RT
- -D debug mode: enable some debug messages
- specify twice for lots of debug messages
- this may slow down MusE massively!
- -m debug mode: trace midi Input
- -M debug mode: trace midi Output
- -s debug mode: trace sync
- -a no audio
- -P n set audio driver real time priority to n
- (Dummy only, default 40. Else fixed by Jack.)
- -Y n force midi real time priority to n (default: audio driver prio +2)
- -p don't load LADSPA plugins
- -I don't load DSSI plugins
- -L don't use LASH
- -l xx force locale to the given language/country code
- (xx = de,en,es,fr,pl,ru,sv_SE)
-
- (JACK and all its clients (qjackctl & MusE) must run with the
- same user id)
-
-
- =============================
- known bugs
- =============================
-
- - not so many: only some usability quirks we're working on currently
- - automation recording displays odd things in the arranger
- while recording; the display is corrected once recording is
- complete.
-
-====================================================================
-Let us know whether MusE works for you !!!
-Have a look at the webpage http://www.muse-sequencer.org for details.
-
-
+/home/col/Source/muse2-20131212-github-master/muse2/README \ No newline at end of file