Skip to content

README: add link to OS-specific build instructions#14779

Merged
acolombier merged 1 commit intomixxxdj:2.5from
ronso0:readme-compiling-link
May 15, 2025
Merged

README: add link to OS-specific build instructions#14779
acolombier merged 1 commit intomixxxdj:2.5from
ronso0:readme-compiling-link

Conversation

@ronso0
Copy link
Copy Markdown
Member

@ronso0 ronso0 commented May 14, 2025

Adds a quick link to https://github.com/mixxxdj/mixxx/wiki#compile-mixxx-from-source-code with detailed build instructions which are currently hard to find, unless you find your way via Documentation -> Wiki -> scroll down to Developer Documentation -> Compile Mixxx From Source Code

@ronso0
Copy link
Copy Markdown
Member Author

ronso0 commented May 14, 2025

Ah, IIRC it's also been discussed to add a BUILDING.md or COMPILING.md

edit here is BUILDING.md from #4432

@acolombier
Copy link
Copy Markdown
Member

How would you feel about moving the content of this wiki (the Compile Mixxx From Source Code only, and the page it references) into markdown file(s) under the docs folder? Something like:

docs/building.md (or just BUILDING.md at the root like in #4432)
docs/linux.md
docs/windows.md
docs/macos.md
docs/packaging.md

The rationale for it would be:

  • Wiki is RO
  • Content is easier to find (e.g grep or ctrl+f on the repo)
  • Vendor agnostic - knowledge lives in in Git vs GH Wiki
  • Contribution (related to the first point, but implying that it gets easier for a contributor to suggest improvement and request somebody to update these page inline with a change they would submit on our tools scripts)

@ronso0
Copy link
Copy Markdown
Member Author

ronso0 commented May 15, 2025

Sure, makes sense!

But let's merge this quick fix first.

@ronso0
Copy link
Copy Markdown
Member Author

ronso0 commented May 15, 2025

I moved your suggestion to #14786

@acolombier acolombier merged commit f581f4b into mixxxdj:2.5 May 15, 2025
3 checks passed
@ronso0 ronso0 deleted the readme-compiling-link branch May 15, 2025 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants