README

Mixxx 2.3

* HOMEPAGE *************************************************

https://www.mixxx.org

* ABOUT ****************************************************

Mixxx is open source DJ software that gives you everything
you need to perform live DJ mixes. Mixxx works on GNU/Linux,
Windows and macOS.

Mixxx is released under GPL v2. See LICENSE file in this
directory for a copy of the license.

* NEWS *****************************************************

Check the Mixxx blog to find out what's new in this version:
https://mixxxblog.blogspot.com

* UPGRADING ************************************************

We recommend deleting your old skins directory before
installing a new version of Mixxx. SCons may not properly
overwrite your skins directory when you do a "scons install",
and it might cause Mixxx to crash on launch.
You can delete it by running:

   $ sudo rm -rf /usr/share/mixxx/skins
   $ sudo rm -rf /usr/local/share/mixxx/skins


* INSTALL **************************************************

Mixxx has the following dependencies:
- libid3tag
- libmad
- libogg
- libvorbis
- libvorbisfile
- libsndfile
- libmodplug
- libflac
- libopus
- libshout
- libhss1394
- taglib
- PortAudio-v19
- portmidi
- Qt 5
- scons
- protocol-buffers
- libusb-1.0
- libmp4v2 (optional, m4a support)
- libfaad (optional, m4a support)
- libchromaprint
- librubberband

NOTE: If you want JACK support in Mixxx, make sure you
compile PortAudio-v19 with JACK support first.

Mixxx's build system is SCons. To compile Mixxx using SCons, run:

   $ scons

SCons does both dependency checking and building, so it will
tell you if you're missing any of the dependencies listed above.
It's also possible to specify a prefix path and additional
build flags, for example:

   $ scons prefix=/usr

To install Mixxx after compilation, run:

   $ sudo scons prefix=/usr install

A full list of scons flags is available by running:

   $ scons --help

WARNING: We do not recommend building Mixxx with any
flags other than the defaults if you are going to use Mixxx
for live performance. Features that are disabled by default
may not compile or may be unstable. Be forewarned.

More detailed compiling instructions are available for your
platform on our wiki:
    https://www.mixxx.org/wiki/

* HERCULES DJ CONSOLE USERS ON LINUX ***********************

Please see: https://www.mixxx.org/wiki/doku.php/hercules
You may need to install the official Hercules Linux drivers
from: http://www.hercules.com/

* REINSTALLING MIXXX ***************************************

Linux users may need to manually remove their Mixxx
installation directory if they need to reinstall. (This does
not apply when reinstalling from a DEB package.) Mixxx's
share directory can be removed by running:

   $ sudo rm -rf /usr/local/share/mixxx/

or

   $ sudo rm -rf /usr/share/mixxx/

* USAGE ****************************************************
Please see the manual, included in this directory,
Mixxx-Manual.pdf or at:

    https://www.mixxx.org/manual/latest

* CONTACT **************************************************
To contact the lead developer, send an email to
rryan@mixxx.org or subscribe to
mixxx-devel@lists.sourceforge.net and send a message to the
list.

* QT *******************************************************
On some platforms, Mixxx may come with a pre-built copy of
Qt. This code is licensed under the LGPL and source for this
library may be obtained from:

    https://www.qt.io/download

* Microsoft Runtimes ***************************************
On Microsoft platforms, Mixxx may come with runtime dlls
copyright of Microsoft. These are distributed for the
purpose of allowing Mixxx to run only as per the license
agreement for Visual Studio 2005.