summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 62e7635c1077008a8800ab93152b8b789b32b1af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# Mixxx

[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.

## Quick Start

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`

## Roadmap

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].

## Bug tracker

The Mixxx team uses [Launchpad] to manage Mixxx development.

Have a bug or feature request? [File a bug on Launchpad][fileabug].

Want to get involved in Mixxx development? Assign yourself a bug from the [easy
bug list][easybugs] and get started!

## Compiling

First, you must install all of Mixxx's dependencies. To compile Mixxx using
[SCons], run:

    $ scons

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].

## Documentation

For help using Mixxx, there are a variety of options:

- [Mixxx manual][manual]
- [Mixxx wiki][wiki]
- [Frequently Asked Questions][FAQ]
- [Hardware Compatibility] (supported soundcards, MIDI/HID controllers)
- [Creating Skins]

## Community

Mixxx is a vibrant community of hackers, DJs and artists. To keep track of
development and community news:

- 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.

## License

Mixxx is released under the GPLv2. See the LICENSE file for a full copy of the
license.

[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
[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