summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBe <be@mixxx.org>2020-12-16 18:01:17 -0600
committerBe <be@mixxx.org>2020-12-16 18:01:17 -0600
commitb884f4f0622a2fdccdd8a41c87639fe603a24fd0 (patch)
treec08d64cc2cd73c274457389d12342491c0d6dcaa /README.md
parent648bc1d0433e67b94157f13fc7c2904d7cd8d5ec (diff)
parente80ce44df0f440e108ca1f0cecb1e16b26517c3e (diff)
Merge remote-tracking branch 'upstream/2.3' into main
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 36 insertions, 17 deletions
diff --git a/README.md b/README.md
index 074c51eb78..de6e94e9b0 100644
--- a/README.md
+++ b/README.md
@@ -31,24 +31,42 @@ 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
-
-* macOS [![Build Status](https://travis-ci.org/mixxxdj/mixxx.svg)](https://travis-ci.org/mixxxdj/mixxx)
-* Ubuntu / Windows [![Build status](https://ci.appveyor.com/api/projects/status/j460rficblcaopwx?svg=true)](https://ci.appveyor.com/project/mixxxdj/mixxx)
-* Jenkins [![Build status](https://img.shields.io/jenkins/s/https/builds.mixxx.org/job/master-release.svg)](https://builds.mixxx.org/job/master-release)
-
-First, you must install all of Mixxx's dependencies. To compile Mixxx using
-[CMake], run:
-
+## Compiling on Linux
$ mkdir build
$ cd build
$ cmake ..
$ cmake --build .
+Please see our helpful guide on the [wiki] for more information: [Compiling on Linux]
-Please see our helpful guides on the [wiki] for more information:
-- [Compiling on Linux]
-- [Compiling on macOS]
-- [Compiling on Windows]
+## Compiling on MacOS
+ $ mkdir build
+ $ cd build
+ $ cmake ..
+ $ cmake --build .
+Please see our helpful guide on the [wiki] for more information: [Compiling on MacOS]
+
+## Compiling on Windows
+### Build Requirements
+- Windows 7 or later
+- MS Visual Studio 2019 (Community Edition is free of charge)
+- At least 10G free diskspace
+- To create an .msi installer, you need to install the WiX toolkit from https://wixtoolset.org/releases/
+### Setup your build environment
+1. Download these sources (using git checkout as described in [Using Git])
+2. Run the batch file `tools\windows_buildenv.bat`
+ - This file downloads the prebuild Mixxx environment, defined in `cmake\windows_build_environment_name` from https://downloads.mixxx.org/builds/buildserver/2.3.x-windows/
+ - Generates the `CMakeSettings.json` with the matching build configurations for Visual Studio
+3. Start Visual Studio, choose "Open a local folder" select the `mixxx` directory containing `CMakeSettings.json`
+4. Menu "Project" -> "Generate Cache for mixxx"
+5. Select the build configuration in the toolbar (`x64__fastbuild` is recommended)
+6. Menu "Build" -> "Build All"
+### Creating an .msi installer (optional)
+7. Than open the Visual Studio 'Developer Command Prompt' by Menu -> "Tools" -> "Command line" -> "Developer Command Prompt"
+8. Go to your build directory, e.g. by "cd .\build\x64-fastbuild"
+9. Run "cpack -G WIX"
+
+
+Please see also our helpful guide on the [wiki] for more information: [Compiling on Windows]
## Documentation
@@ -94,12 +112,13 @@ license.
[facebook]: https://www.facebook.com/pages/Mixxx-DJ-Software/21723485212
[blog]: https://mixxxblog.blogspot.com
[manual]: https://www.mixxx.org/manual/latest/
-[wiki]: https://www.mixxx.org/wiki/
+[wiki]: https://github.com/mixxxdj/mixxx/wiki
[faq]: https://mixxx.org/wiki/doku.php/faq
[forums]: https://www.mixxx.org/forums/
-[compiling on linux]: https://mixxx.org/wiki/doku.php/compiling_on_linux
-[compiling on macOS]: https://mixxx.org/wiki/doku.php/compiling_on_os_x
-[compiling on windows]: https://mixxx.org/wiki/doku.php/compiling_on_windows
+[Compiling on Linux]: https://github.com/mixxxdj/mixxx/wiki/Compiling%20on%20Linux
+[Compiling on MacOS]: https://github.com/mixxxdj/mixxx/wiki/Compiling%20on%20macOS
+[Compiling on Windows]: https://github.com/mixxxdj/mixxx/wiki/compiling-on-windows
+[Using Git]: https://github.com/mixxxdj/mixxx/wiki/Using-Git
[mailing list]: https://lists.sourceforge.net/lists/listinfo/mixxx-devel
[CMake]: https://cmake.org/
[launchpad 2.3.0]: https://launchpad.net/mixxx/+milestone/2.3.0