Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b2a3800e authored by Gaël Duval's avatar Gaël Duval 🏄🏼
Browse files

Improve documentation

parent 47a144a9
Loading
Loading
Loading
Loading
+12 −7
Original line number Diff line number Diff line
@@ -6,9 +6,13 @@ permalink: how-tos/install-heimdall

# Install Heimdall

Heimdall project does not provide package for the last version. So you need to build it manually. Bellow the documentation for each platform, extracted from README of Heimdall project.
The Heimdall project does not provide package for the last version. So you need to build it manually from [its sources](https://gitlab.com/BenjaminDobell/Heimdall). Bellow the documentation for each platform, extracted from README of Heimdall project.

## Windows (Source: [Heimdall/Win32/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Win32/README.txt#L518))
## Download Heimdall sources

Download from [Heimdall source code repository](https://gitlab.com/BenjaminDobell/Heimdall)

## If you are building on Windows (Source: [Heimdall/Win32/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Win32/README.txt#L518))

Heimdall and Heimdall Frontend both utilise CMake for managing the build process. CMake can generate files for various build systems including GNU Make and Visual Studio. However, official packages are compiled with GNU Make and MinGW-W64 GCC/G++.

@@ -32,7 +36,8 @@ cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Release -DQt5Widgets_DIR=/c/msys64/
make
```

## Linux (Source: [Heimdall/Linux/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Linux/README#L475))
## If you are building on Linux (Source: [Heimdall/Linux/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Linux/README#L475))

1. First make sure you have installed `build-essential`, `cmake`, `zlib1g-dev`, `qt5-default`, `libusb-1.0-0-dev` and `OpenGL` (e.g `libgl1-mesa-glx` and `libgl1-mesa-dev`). **NOTE**: Package names may not be absolutely identical to those above.
2. Open a terminal and navigate to the directory you downloaded, or extracted, Heimdall to.
3. Enter the following commands to compile Heimdall Suite:
@@ -40,10 +45,10 @@ make
mkdir build cd build cmake -DCMAKE_BUILD_TYPE=Release .. make
```

## Mac OSX (Source : [Heimdall/OSX/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/OSX/README.txt#L480))
1. Apply following patches
    * https://gitlab.com/BenjaminDobell/Heimdall/issues/480
    * https://gitlab.com/bfabiszewski/Heimdall/commit/49416216c6d131769521c7f2c573cc78455941b2
## If you are building on Mac OSX (Source : [Heimdall/OSX/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/OSX/README.txt#L480))

1. Apply following patch:
    * [https://gitlab.com/bfabiszewski/Heimdall/commit/49416216c6d131769521c7f2c573cc78455941b2](https://gitlab.com/bfabiszewski/Heimdall/commit/49416216c6d131769521c7f2c573cc78455941b2)
1. Open Terminal and install dependencies using Homebrew (http://brew.sh)
```
brew install libusb qt5 cmake