summaryrefslogtreecommitdiffstats
path: root/BUILD.md
diff options
context:
space:
mode:
authorSky <git@bunnies.cc>2013-10-31 20:28:10 +0000
committerSky <git@bunnies.cc>2013-10-31 20:28:10 +0000
commit8c7f15cefb17b036d4f55ca5283e26cb64ff2fc7 (patch)
treed0791d494c9b9eef48b6a768a93ab2562ca7c974 /BUILD.md
parent8cd6604e40ae5d250f6826d0c7a1985e719ec66c (diff)
downloadMultiMC-8c7f15cefb17b036d4f55ca5283e26cb64ff2fc7.tar
MultiMC-8c7f15cefb17b036d4f55ca5283e26cb64ff2fc7.tar.gz
MultiMC-8c7f15cefb17b036d4f55ca5283e26cb64ff2fc7.tar.lz
MultiMC-8c7f15cefb17b036d4f55ca5283e26cb64ff2fc7.tar.xz
MultiMC-8c7f15cefb17b036d4f55ca5283e26cb64ff2fc7.zip
Revamp Linux build instructions for Qt Creator
Diffstat (limited to 'BUILD.md')
-rw-r--r--BUILD.md76
1 files changed, 34 insertions, 42 deletions
diff --git a/BUILD.md b/BUILD.md
index e2c17e64..6454bfb7 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -8,55 +8,47 @@ Build Instructions
# Linux
-## Dependencies
+Getting the project to build and run on Linux is easy if you use Ubuntu 13.10 (or 13.04) and Qt's IDE, Qt Creator.
-* Qt 5.1.1+ Development tools (http://qt-project.org/downloads)
-* cmake
-* ccmake
-* make
-* g++
+## Dependencies
+* Qt 5.1.1+ Development tools (http://qt-project.org/downloads) ("Qt Online Installer for Linux (64 bit)")
* A copy of the MultiMC source (clone it with git)
+* cmake
+* build-essentials
+* zlib (for example, zlib1g-dev)
+* java (for example, openjdk-7-jdk)
+* GL headers (for example, libgl1-mesa-dev)
## Getting set up
-```bash
-git clone git@github.com:MultiMC/MultiMC5.git # get the code
-cd MultiMC5
-git checkout develop
-```
-
-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.
+### Installing dependencies
+Just run `sudo apt-get install <dependency>` for each dependency (other than Qt and the MultiMC source) from above.
-Then hit c and g. If the window stays open (and g has no effect) retry c followed by g. sometimes you need to use c twice.
-If you get an error make sure you have all dependencies installed and configured the paths properly
-
-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:
+### Installing Qt
+1. Run the Qt installer
+2. Choose a place to install Qt,
+3. Choose the components you want to install
+ - You need Qt 5.1.1/gcc 64-bit ticked,
+ - You need Tools/Qt Creator ticked,
+ - Other components are selected by default, you can untick them if you don't need them.
+4. Accept the license agreements,
+5. Double check the install details and then click "Install"
+ - Installation can take a very long time, go grab a cup of tea or something and let it work.
-```bash
-cd run # or whereever its stored
-./MultiMC5
-```
+### Loading the project
+1. Open Qt Creator,
+2. Choose File->Open File or Project,
+3. Navigate to the MultiMC5 source folder you cloned and choose CMakeLists.txt,
+4. Read the instructions that just popped up about a build location and choose one,
+5. You should see "Run CMake" in the window,
+ - Make sure that Generator is set to "Unix Generator (Desktop Qt 5.1.1 GCC 64bit)",
+ - Hit the "Run CMake" button,
+ - You'll see warnings and it might not be clear that it succeeded until you scroll to the bottom of the window.
+ - Hit "Finish" if CMake ran successfully.
+6. Cross your fingers and press the Run button (bottom left of Qt Creator)!
+ - If the project builds successfully it will run and the MultiMC5 window will pop up.
-Congrats. Your MMC5 should run
+*These build instructions worked for me (Drayshak) on a fresh Ubuntu 13.10 x64 install. If they don't work for you, let us know on IRC (Esper/#MultiMC)!*
# Windows
@@ -112,4 +104,4 @@ Getting the project to build and run on Windows is easy if you use Qt's IDE, Qt
# OS X
-*There are no build instructions for OS X yet. If you can help with this section please contact us on IRC (Esper/#MultiMC)!* \ No newline at end of file
+*There are no build instructions for OS X yet. If you can help with this section please contact us on IRC (Esper/#MultiMC)!*