Skip to content

Commit

Permalink
Merge PR #6672: DOCS: Mention differences in documentation across bra…
Browse files Browse the repository at this point in the history
…nches
  • Loading branch information
Hartmnt authored Dec 25, 2024
2 parents edd4588 + 3326494 commit 2fc3004
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ information on how this works and how these have to be created in the [plugin do

For information on how to build Mumble, check out [the dedicated documentation](docs/dev/build-instructions/README.md).

Make sure to switch to the appropriate branch in this repository to get the correct build documentation. The current ``master`` branch contains
the unstable code for a future release of Mumble. If you want to build an already released stable version of Mumble, e.g. ``1.5.735``, select the
corresponding branch, e.g. ``1.5.x``, in the dropdown menu above. Alternatively, use the documentation in the respective release tarball.


## Reporting issues

Expand Down
3 changes: 3 additions & 0 deletions docs/dev/build-instructions/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Build Mumble

This documentation is version-specific. The current ``master`` branch contains the unstable code for a future release of Mumble.
If you want to build an already released stable version of Mumble, use the respective branch.

A fundamental dependency for building Mumble is [git](https://git-scm.com/), so make sure you have it installed. If you are new to git, make sure to
checkout [this guide](https://guides.github.com/introduction/git-handbook/) on git's basics in order to be able to follow the given instructions.

Expand Down

0 comments on commit 2fc3004

Please sign in to comment.