summaryrefslogtreecommitdiffstats
path: root/BUILD.md
diff options
context:
space:
mode:
authorStiepen22 <stiepen22@gmx.de>2013-09-22 15:32:55 +0200
committerStiepen22 <stiepen22@gmx.de>2013-09-22 15:32:55 +0200
commitb0fb2e48ac2873b8e35fcd686a47c6ea37fe918c (patch)
treeb5a0c5f7675b8fdab58ea9c998fcfff46cf287ce /BUILD.md
parent1bed5e4023f503cb95a914c1e6886e045b7f34e2 (diff)
downloadMultiMC-b0fb2e48ac2873b8e35fcd686a47c6ea37fe918c.tar
MultiMC-b0fb2e48ac2873b8e35fcd686a47c6ea37fe918c.tar.gz
MultiMC-b0fb2e48ac2873b8e35fcd686a47c6ea37fe918c.tar.lz
MultiMC-b0fb2e48ac2873b8e35fcd686a47c6ea37fe918c.tar.xz
MultiMC-b0fb2e48ac2873b8e35fcd686a47c6ea37fe918c.zip
Added Build instructions
Diffstat (limited to 'BUILD.md')
-rw-r--r--BUILD.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/BUILD.md b/BUILD.md
new file mode 100644
index 00000000..c536e588
--- /dev/null
+++ b/BUILD.md
@@ -0,0 +1,62 @@
+## Table of Contents
+
+Build on...
+
+* [Linux](#linux)
+* [Windows](#win)
+* [OSX](#osx)
+
+## <a id="linux"></a>Linux
+
+```bash
+git clone git@github.com:MultiMC/MultiMC5.git # get the code
+cd MultiMC5
+```
+
+now you need to install (unless already installed):
+
+1. Qt 5.1.1+ Development tools (http://qt-project.org/downloads)
+1. cmake
+1. ccmake
+1. make
+1. g++
+
+once that is done, do these commands:
+
+```bash
+mkdir build
+cd build
+ccmake ..
+```
+
+A GUI will pop up. press the c key. now set the build prefix. if you are in /home/username/code/MultiMC5/build then put /home/username/code/MultiMC5/build/run as build prefix. if you want you can choose whatever dir you want, but then you need to adjust the path when running it. to edit the value use the up/down keys to select it and hit return to edit it. after you are done hit return again.
+Also adjust the paths to your qt install.
+
+Then hit c and g
+
+continue with the following commands:
+
+```bash
+cmake ..
+make
+make translations_target # compiles localization files. you may leave this out if your language is english
+make install
+```
+now you compiled it (hupefully) successfully.
+
+to launch it:
+
+```bash
+cd run # or whereever its stored
+./MultiMC5
+```
+
+Congrats. Your MMC5 should run
+
+## <a id="win"></a>Windows
+
+*In work*
+
+## <a id="osx"></a>OSX
+
+*MMC5 is not working on OSX yet. If you get it somehow working anyways, tell us how* \ No newline at end of file