diff --git a/dist/compiling/linux.md b/dist/compiling/linux.md index a2cb8122a..d450f1274 100644 --- a/dist/compiling/linux.md +++ b/dist/compiling/linux.md @@ -1,9 +1,12 @@ ### Compiling ImHex on Linux -Dependency installation scripts are available for many common Linux distributions in the [/dist](dist) folder. -After all the dependencies are installed, run the following commands to build ImHex: +On Linux, ImHex is built through regular GCC (or optionally Clang). +1. Clone the repo using `git clone https://github.com/WerWolv/ImHex --recurse-submodules` +2. Install the dependencies using one of the `dist/get_deps_*.sh` scripts. Choose the one that matches your distro. +3. Build ImHex itself using the following commands: ```sh +cd ImHex mkdir -p build cd build CC=gcc-12 CXX=g++-12 cmake \ @@ -15,27 +18,10 @@ CC=gcc-12 CXX=g++-12 cmake \ -DCMAKE_CXX_FLAGS="-fuse-ld=lld" \ -DCMAKE_OBJC_COMPILER_LAUNCHER=ccache \ -DCMAKE_OBJCXX_COMPILER_LAUNCHER=ccache \ - -DRUST_PATH="$HOME/.cargo/bin/" \ .. make -j 4 install ``` ---- - -Put the ImHex executable into the `/usr/bin` folder. -Put libimhex.so into the `/usr/lib` folder. -Configuration files go to `/usr/etc/imhex` or `~/.config/imhex`. -All other files belong in `/usr/share/imhex` or `~/.local/share/imhex`: - -``` -Patterns: /usr/share/imhex/patterns -Pattern Includes: /usr/share/imhex/includes -Magic files: /usr/share/imhex/magic -Python: /usr/share/imhex/lib/pythonX.X -Plugins: /usr/share/imhex/plugins -Configuration: /etc/xdg/imhex/config -``` - All paths follow the XDG Base Directories standard, and can thus be modified with the environment variables `XDG_CONFIG_HOME`, `XDG_CONFIG_DIRS`, `XDG_DATA_HOME` and `XDG_DATA_DIRS`. \ No newline at end of file diff --git a/dist/compiling/macOS.md b/dist/compiling/macOS.md index b375c22a6..04c9b5fb2 100644 --- a/dist/compiling/macOS.md +++ b/dist/compiling/macOS.md @@ -1,9 +1,12 @@ ### Compiling ImHex on macOS -To build ImHex on macOS, run the following commands: +On macOS, ImHex is built through regular GCC and AppleClang. +1. Clone the repo using `git clone https://github.com/WerWolv/ImHex --recurse-submodules` +2. Install all the dependencies using `brew bundle --no-lock --file dist/Brewfile` +3. Build ImHex itself using the following commands: ```sh -brew bundle --no-lock --file dist/Brewfile +cd ImHex mkdir -p build cd build CC=$(brew --prefix gcc@12)/bin/gcc-12 \ @@ -24,18 +27,6 @@ cmake \ make -j4 package ``` -Open the generated .dmg file and drag-n-drop the ImHex executable to the Applications folder - -All other files belong in `~/Library/Application Support/imhex`: -``` -Patterns: ~/Library/Application Support/imhex/patterns -Pattern Includes: ~/Library/Application Support/imhex/includes -Magic files: ~/Library/Application Support/imhex/magic -Python: ~/Library/Application Support/imhex/lib/pythonX.X -Plugins: ~/Library/Application Support/imhex/plugins -Configuration: ~/Library/Application Support/imhex/config -``` - If the build fails while trying to find the macOS libraries, make sure you have XCode installed with `xcode-select --install`. Homebrew will also help get the most recent SDK installed and configured with `brew doctor`. \ No newline at end of file diff --git a/dist/compiling/windows.md b/dist/compiling/windows.md index 65c740777..450d5ad4e 100644 --- a/dist/compiling/windows.md +++ b/dist/compiling/windows.md @@ -1,9 +1,14 @@ ### Compiling ImHex on Windows -On Windows, ImHex is built through msys2 / mingw. To install all dependencies, open a msys2 window and run the PKGCONFIG script in the [dist/msys2](dist/msys2) folder. -After all the dependencies are installed, run the following commands to build ImHex: +On Windows, ImHex is built through [msys2 / mingw](https://www.msys2.org/)'s gcc. +1. Download and install msys2 from their [website](https://www.msys2.org/). +2. Open the `MSYS2 MinGW x64` shell +3. Clone the repo using `git clone https://github.com/WerWolv/ImHex --recurse-submodules` +4. Install all the dependencies using `./ImHex/dist/get_deps_msys2.sh` +5. Build ImHex itself using the following commands: ```sh +cd ImHex mkdir build cd build cmake -G "MinGW Makefiles" \