Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mumble-voip/mumble.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/build-instructions/README.md')
-rw-r--r--docs/dev/build-instructions/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/dev/build-instructions/README.md b/docs/dev/build-instructions/README.md
new file mode 100644
index 000000000..326dd64d7
--- /dev/null
+++ b/docs/dev/build-instructions/README.md
@@ -0,0 +1,19 @@
+# Build Mumble
+
+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.
+
+The first step in building Mumble is to clone this repository via `git clone https://github.com/mumble-voip/mumble.git`.
+
+In order to actually build Mumble, you can follow one of the following instruction sets:
+- [Build on Windows](build_windows.md)
+- [Build on Linux](build_linux.md)
+- [Build on macOS](build_macos.md)
+- [Static build](build_static.md)
+
+
+Furthermore you might find these helpful as well:
+- [FAQ](faq.md)
+- [List of available cmake options](cmake_options.md)
+- [IDE integration](ide_integration.md)
+- [Create an installer](build_installer.md)