diff --git a/docs/building.md b/docs/building.md index 792da737b..843787d6d 100644 --- a/docs/building.md +++ b/docs/building.md @@ -88,18 +88,24 @@ get helpful spacers/movs in the disassembly. Linux support is extremely experimental and presently incomplete. -The build script uses LLVM/Clang 19. GCC while it should work in theory, is not easily +The build script uses Clang 19. GCC while it should work in theory, is not easily interchangeable right now. * Normal building via `xb build` uses CMake+Ninja. -* [CodeLite](https://codelite.org) is supported. `xb devenv` will generate a workspace and attempt to open it. Your distribution's version may be out of date so check their website. -* Experimental CMake generation is available to facilitate use of other IDEs such as [CLion](https://www.jetbrains.com/clion/). If `clion` is available inside `$PATH`, `xb devenv` will start it. Otherwise `build/CMakeLists.txt` needs to be generated by invoking `xb premake --devenv=cmake` manually. +* Environment variables: + Name | Default Value + ----- | ------------- + `CC` | `clang` + `CXX` | `clang++` + + Clang-19 or newer should be available from system repositories on all up to date distributions. You will also need some development libraries. To get them on an Ubuntu system: ```sh -sudo apt-get install mesa-vulkan-drivers valgrind libc++-dev libc++abi-dev libgtk-3-dev libsdl2-dev libvulkan-dev libx11-xcb-dev clang-19 llvm-19 ninja-build +sudo apt-get install build-essential mesa-vulkan-drivers valgrind libc++-dev libc++abi-dev libgtk-3-dev liblz4-dev libsdl2-dev libvulkan-dev libx11-xcb-dev clang-19 llvm-19 ninja-build ``` In addition, you will need up to date Vulkan libraries and drivers for your hardware, which most distributions have in their standard repositories nowadays.