diff options
author | RJ Ryan <rryan@mixxx.org> | 2013-06-19 10:28:28 -0400 |
---|---|---|
committer | RJ Ryan <rryan@mixxx.org> | 2013-06-19 10:28:28 -0400 |
commit | 6ef0a6a211d7236043850cb25bb0a5a9e48e2660 (patch) | |
tree | 21fb3ccceb742d07eaa36a211a15251cd980f3d4 /README.md | |
parent | 792d99a606c87eb55293d027749da6eb7ba5ed06 (diff) |
Update README.md to be more developer oriented.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 160 |
1 files changed, 61 insertions, 99 deletions
@@ -1,123 +1,85 @@ -# MIXXX # -[Mixxx] is open source software for DJ'ing. You can perform -live beatmixes with MP3s, OGGs, and other formats. Mixxx -also supports a number of DJ MIDI controllers. -Mixxx works on Linux, Windows and MacOS X. - -Mixxx is released under GPL v2. See LICENSE file in this -directory for a copy of the licence. - -## NEWS ## -Check the Mixxx [blog] to find out what's new in this version: - -## USAGE ## -Please see the manual, included in this directory [Mixxx-Manual] - -## INSTALL ## -Mixxx has the following dependencies: -- libid3tag -- libmad -- libchromaprint -- libogg -- libvorbis -- libvorbisfile -- libsndfile -- libflac -- libshout -- libhss1394 -- taglib (New in 1.9!) -- PortAudio-v19 -- portmidi -- QT 4.6+ -- scons -- protocol-buffers -- libusb-1.0 -- libmp4v2 (optional, m4a support) -- libfaad (optional, m4a support) -- vamp-plugin-sdk (optional, internal version included) - -NOTE: If you want JACK support in Mixxx, make sure you -compile PortAudio-v19 with JACK support first. - -To compile Mixxx using SCONS, go into the "mixxx" -directory and run: +# Mixxx - $ 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 +[Mixxx] is Free DJ software that gives you everything you need to perform live +mixes. Mixxx works on GNU/Linux, Windows, and Mac OS X. -To install Mixxx after compilation, run: +## Quick Start - $ sudo scons prefix=/usr install +To get started with Mixxx: +1. For live use, [download the latest stable version][download]. +2. For experimentation and testing, [download a development release][builds]. +3. To live on the bleeding edge, clone the repo: `git clone https://github.com/mixxxdj/mixxx.git` -A full list of scons flags is available by running: +## Roadmap - $ scons --help +The Mixxx team is hard at work on Mixxx 1.12.0. The best place to keep track of +1.12.0 development is the [1.12.0 milestone page on Launchpad][launchpad 1.12.0]. -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. +## Bug tracker -More detailed compiling instructions are available for your -platform on our [wiki] +The Mixxx team uses [Launchpad] to manage Mixxx development. +Have a bug or feature request? [File a bug on Launchpad][fileabug]. -### UPGRADING ### +Want to get involved in Mixxx development? Assign yourself a bug from the [easy +bug list][easybugs] and get started! -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: +## Compiling - $ sudo rm -rf /usr/share/mixxx/skins - $ sudo rm -rf /usr/local/share/mixxx/skins +First, you must install all of Mixxx's dependencies. To compile Mixxx using +[SCons], run: -### 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: + $ scons - $ sudo rm -rf /usr/local/share/mixxx/ +Please see our helpful guides on the [Mixxx wiki] for more information: +- [Compiling on Linux][compiling on linux]. +- [Compiling on OS X][compiling on osx]. +- [Compiling on Windows][compiling on windows]. -or +## Documentation - $ sudo rm -rf /usr/share/mixxx/ +For help using Mixxx, there are a variety of options: -## 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. +- [Mixxx manual][manual] +- [Mixxx wiki][wiki] +- [Frequently Asked Questions][FAQ] +- [Hardware Compatibility] (supported soundcards, MIDI/HID controllers) +- [Creating Skins] -### HERCULES DJ CONSOLE USERS ON LINUX ### +## Community -Please see: http://www.mixxx.org/wiki/doku.php/hercules -You may need to install the official Hercules Linux drivers -from: http://www.hercules.com/ +Mixxx is a vibrant community of hackers, DJs and artists. To keep track of +development and community news: -### 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: +- Follow [@mixxxdj on Twitter][twitter], +- Subscribe to the [Mixxx Development Blog][blog]. +- Join the developer [mailing list]. +- Post on the [Mixxx forums][forums] +- Join our [#mixxx on Freenode IRC][irc channel] to chat with us. -http://qt-project.org/downloads +## License -### 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. +Mixxx is released under the GPLv2. See the LICENSE file for a full copy of the +license. -[Mixxx]: http://www.mixxx.org +[mixxx]: http://www.mixxx.org +[download]: http://www.mixxx.org/download +[builds]: http://builds.mixxx.org/builds/ +[launchpad]: http://bugs.launchpad.net/mixxx +[fileabug]: http://bugs.launchpad.net/mixxx/+filebug +[twitter]: http://twitter.com/mixxxdj [blog]: http://mixxxblog.blogspot.com -[Mixxx-Manual]: http://www.mixxx.org/manual +[manual]: http://www.mixxx.org/manual/latest/ [wiki]: http://www.mixxx.org/wiki/ +[faq]: http://mixxx.org/wiki/doku.php/faq +[forums]: http://www.mixxx.org/forums/ +[compiling linux]: http://mixxx.org/wiki/doku.php/compiling_on_linux +[compiling osx]: http://mixxx.org/wiki/doku.php/compiling_on_os_x +[compiling windows]: http://mixxx.org/wiki/doku.php/compiling_on_windows +[mailing list]: https://lists.sourceforge.net/lists/listinfo/mixxx-devel +[irc channel]: http://mixxx.org/irc.php +[SCons]: http://www.scons.org/ +[launchpad 1.12.0]: https://launchpad.net/mixxx/+milestone/1.12.0 +[easybugs]: https://bugs.launchpad.net/mixxx/+bugs?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&assignee_option=any&field.assignee=&field.bug_reporter=&field.bug_commenter=&field.subscriber=&field.structural_subscriber=&field.tag=easy&field.tags_combinator=ANY&field.has_cve.used=&field.omit_dupes.used=&field.omit_dupes=on&field.affects_me.used=&field.has_patch.used=&field.has_branches.used=&field.has_branches=on&field.has_no_branches.used=&field.has_no_branches=on&field.has_blueprints.used=&field.has_blueprints=on&field.has_no_blueprints.used=&field.has_no_blueprints=on +[creating skins]: http://mixxx.org/wiki/doku.php/creating_skins +[hardware compatibility]: http://mixxx.org/wiki/doku.php/hardware_compatibility |