Merge branch '2.3'

CMakeLists.txt

@@ -1289,7 +1289,7 @@ install(
 # Documentation
 install(
   FILES
-    "${CMAKE_CURRENT_SOURCE_DIR}/README"
+    "${CMAKE_CURRENT_SOURCE_DIR}/README.md"
     "${CMAKE_CURRENT_SOURCE_DIR}/res/Mixxx-Keyboard-Shortcuts.pdf"
   DESTINATION
     "${MIXXX_INSTALL_DOCDIR}"
@@ -2733,7 +2733,7 @@ set(CPACK_PACKAGE_EXECUTABLES "mixxx;Mixxx")
 set(CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/res/images/mixxx_install_logo.bmp")
 set(CPACK_PACKAGE_HOMEPAGE_URL "https://www.mixxx.org/")
 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
-set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README")
+set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
 set(CPACK_STRIP_FILES ON)
 set(CPACK_CREATE_DESKTOP_LINKS "mixxx")
 set(CPACK_MIXXX_VERSION "${MIXXX_VERSION}")

README.md

@@ -1,8 +1,8 @@
 # Mixxx
-[![GitHub latest tag](https://img.shields.io/github/tag/mixxxdj/mixxx.svg)](https://www.mixxx.org/download)
+[![GitHub latest tag](https://img.shields.io/github/tag/mixxxdj/mixxx.svg)](https://mixxx.org/download)
 [![Packaging status](https://repology.org/badge/tiny-repos/mixxx.svg)](https://repology.org/metapackage/mixxx/versions)
 [![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://mixxx.zulipchat.com)
-[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QSFMYWN2B3JD2&source=url)
+[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://mixxx.org/donate)
 
 [Mixxx] is Free DJ software that gives you everything you need to perform live
 DJ mixes. Mixxx works on GNU/Linux, Windows, and macOS.
@@ -11,17 +11,10 @@ DJ mixes. Mixxx works on GNU/Linux, Windows, and macOS.
 
 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].
+1. For live use, [download the latest stable version][download-stable].
+2. For experimentation and testing, [download a development release][download-testing].
 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 2.3. The best place to keep track of
-2.3 development is the [2.3.0 milestone page on Launchpad][launchpad 2.3.0].
-
-A more general roadmap can be found on [the wiki][wiki roadmap].
-
 ## Bug tracker
 
 The Mixxx team uses [Launchpad] to manage Mixxx development.
@@ -31,42 +24,32 @@ 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 on Linux
-    $ mkdir build
-    $ cd build
-    $ cmake ..
-    $ cmake --build .
-Please see our helpful guide on the [wiki] for more information: [Compiling on Linux]
+## Building Mixxx
+
+First, open a terminal (on Windows, use "x64 Native Tools command prompt for
+VS2019"), download the mixxx source code and navigate to it:
+
+    $ git clone https://github.com/mixxxdj/mixxx.git
+    $ cd mixxx
+
+Fetch the required dependencies (on Windows, macOS and Debian/Ubuntu, you can
+do that by running `tools\windows_buildenv.bat`, `source
+tools/macos_buildenv.sh setup` or `source tools/debian_buildenv.sh setup`
+respectively), then run:
 
-## Compiling on MacOS
     $ mkdir build
     $ cd build
-    $ cmake ..
+    $ cmake ..   # Use `cmake -G Ninja ..` on Windows
     $ 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__portable` 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-portable"
-9. Run "cpack -G WIX"
-
-
-Please see also our helpful guide on the [wiki] for more information: [Compiling on Windows]
+
+There should now be a `mixxx` executable in the current directory that you can
+run. Alternatively, can generate a package using `cpack`.
+
+More Information can be found on the [wiki]:
+
+- [Compiling on Linux]
+- [Compiling on macOS]
+- [Compiling on Windows]
 
 ## Documentation
 
@@ -94,41 +77,34 @@ development and community news:
 
 - Chat with us on [Zulip][zulip].
 - Follow us on [Twitter] and [Facebook].
-- Subscribe to the [Mixxx Development Blog][blog].
-- Join the developer [mailing list].
+- Subscribe to the [Mixxx Blog][blog].
 - Post on the [Mixxx forums][discourse].
 
 ## License
 
 Mixxx is released under the GPLv2. See the LICENSE file for a full copy of the
 license.
 
-[mixxx]: https://www.mixxx.org
-[download]: https://www.mixxx.org/download
-[builds]: https://downloads.mixxx.org/builds/
-[launchpad]: https://bugs.launchpad.net/mixxx
+[mixxx]: https://mixxx.org
+[download-stable]: https://mixxx.org/download/#stable
+[download-testing]: https://mixxx.org/download/#testing
 [fileabug]: https://bugs.launchpad.net/mixxx/+filebug
 [twitter]: https://twitter.com/mixxxdj
 [facebook]: https://www.facebook.com/pages/Mixxx-DJ-Software/21723485212
-[blog]: https://mixxxblog.blogspot.com
-[manual]: https://www.mixxx.org/manual/latest/
+[blog]: https://mixxx.org/news/
+[manual]: https://manual.mixxx.org/
 [wiki]: https://github.com/mixxxdj/mixxx/wiki
-[faq]: https://mixxx.org/wiki/doku.php/faq
-[forums]: https://www.mixxx.org/forums/
+[faq]: https://github.com/mixxxdj/mixxx/wiki/Faq
 [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
-[wiki roadmap]: https://mixxx.org/wiki/doku.php/development_roadmap
 [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]: https://mixxx.org/wiki/doku.php/Creating-Skins
 [help translate content]: https://www.transifex.com/projects/p/mixxxdj
-[Mixxx i18n wiki]: https://mixxx.org/wiki/doku.php/internationalization
-[Mixxx localization forum]: https://mixxx.org/forums/viewforum.php?f=10
+[Mixxx i18n wiki]: https://github.com/mixxxdj/mixxx/wiki/Internationalization
+[Mixxx localization forum]: https://mixxx.discourse.group/c/translation/13
 [Mixxx glossary]: https://www.transifex.com/projects/p/mixxxdj/glossary/l/en/
-[hardware compatibility]: https://mixxx.org/wiki/doku.php/Hardware-Compatibility
+[hardware compatibility]: https://github.com/mixxxdj/mixxx/wiki/Hardware-Compatibility
 [zulip]: https://mixxx.zulipchat.com/
 [discourse]: https://mixxx.discourse.group/