diff --git a/README.md b/README.md
index b93cd81a9..cc39189b2 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# NumbatUI: source code and graph explorer
-:warning: This fork of Sourcetrail is in active development and really unstable, we recommend to not use it before our first releases.
+_:warning: This fork of Sourcetrail is in active development and unstable, we recommend to not use it in production environments._
@@ -19,11 +19,12 @@ Features added are:
* **custom commands** (to perform any user-defined action on nodes/edges, e.g., open a terminal at a given path, open a web page, etc.)
+## Installation
+We strongly recommend to use precompiled packages or our Docker image. For manual compilation, see the dedicated page in [documentation](https://quarkslab.github.io/NumbatUI/installation/#manual-build).
-## Usage
+### Docker Image
-We strongly recommend using the provided Docker image to run NumbatUI, as
-it contains all the required dependencies. You can either:
+You can either:
- Build locally the docker image:
```bash
cd docker
@@ -34,40 +35,22 @@ it contains all the required dependencies. You can either:
docker pull ghcr.io/quarkslab/numbatui:main
```
-Then open the */path/to/my_database.srctrlprj* database with NumbatUI. The command will depend of your windowing system, as the application is a GUI Qt application
-one needs to forward the X11/Wayland display to the container.
+NumbatUI is a Qt GUI application, so the container needs access to your display
+server. Check [documentation](https://quarkslab.github.io/NumbatUI/installation/#docker-recommended) for details.
+### Debian Package (.deb)
-- For **X11** users, run the following command. You may need to add allow `docker` to use your Xserver.
-> [!NOTE]
-> You may need to add allow `docker` to use your Xserver.
-> ```bash
-> xhost +local:docker
-> ```
-> After usage, you can remove this authorization with:
-> ```bash
-> xhost -local:docker
-> ```
+- Download the `.deb` package from [Realeases](https://github.com/quarkslab/NumbatUI/releases).
+- Install it on your system:
```bash
- docker run -it --rm \
- --env DISPLAY=$DISPLAY \
- --env QT_X11_NO_MITSHM=1 \
- --volume /tmp/.X11-unix:/tmp/.X11-unix \
- --volume /path/to/:/data/ \
- numbatui:latest /data/my_database.srctrlprj
- ```
-- For **Wayland** users, run the following command:
- ```bash
- docker run -it --rm \
- --env QT_QPA_PLATFORM=wayland \
- --env XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \
- --env WAYLAND_DISPLAY=$WAYLAND_DISPLAY \
- --volume /run/user/1000/$WAYLAND_DISPLAY:/run/user/1000/$WAYLAND_DISPLAY \
- --volume /usr/share/wayland-sessions:/usr/share/wayland-sessions \
- --volume /path/to/:/data/ \
- numbatui:latest /data/my_database.srctrlprj
+ sudo dpkg -i numbatui.deb
```
+## Usage
+
+Open the */path/to/my_database.srctrlprj* database with NumbatUI. The command will depend of your windowing system, as the application is a GUI Qt application
+one needs to forward the X11/Wayland display to the container.
+
## Supported Languages
@@ -97,127 +80,6 @@ Python indexing (inherited from Sourcetrail's `SourcetrailPythonIndexer`) is
currently **disabled by design** and is not built. Support may be revisited in
a future release.
-
-## Manual Installation
-As this fork is currently a WIP, the application should be compiled by
-the user. Build instructions are provided for Linux and macOS.
-
-### Requirements
-
-#### Linux (Ubuntu/Debian)
-- base tooling: `build-essential`, `cmake`, `git`, `unzip`, `wget`
-- LLVM dependencies: `libc++-19-dev`, `liblld-19-dev`, `llvm-19-dev`, `libclang-19-dev`, `clang-19`
-- boost: `libboost-filesystem-dev`, `libboost-program-options-dev`,`libboost-system-dev`, `libboost-date-time-dev`
-- Qt6: `qt6-svg-dev`, `qt6-base-dev`, `qt6-5compat-dev`
-
-#### macOS (Homebrew)
-
-Tested on Apple Silicon (arm64) with macOS 26 / Tahoe and Homebrew Qt 6.11.
-
-```bash
-brew install cmake boost qt@6
-# Only needed if you re-enable BUILD_CXX_LANGUAGE_PACKAGE:
-# brew install llvm@19
-```
-
-### Compilation
-
-From the NumbatUI directory:
-
-```bash
-git clone --recurse-submodules https://github.com/Quarkslab/NumbatUI.git
-cd NumbatUI
-
-cmake -B build \
- -DCMAKE_BUILD_TYPE="Release" \
- -DBUILD_CXX_LANGUAGE_PACKAGE=OFF \
- -DBUILD_PYTHON_LANGUAGE_PACKAGE=OFF
-
-cmake --build build --target NumbatUI -j $(nproc)
-```
-
-On macOS, point CMake at the Homebrew Qt6 install and use `sysctl` for the
-parallel job count:
-
-```bash
-cmake -B build \
- -DCMAKE_BUILD_TYPE="Release" \
- -DBUILD_CXX_LANGUAGE_PACKAGE=OFF \
- -DBUILD_PYTHON_LANGUAGE_PACKAGE=OFF \
- -DCMAKE_PREFIX_PATH=$(brew --prefix qt@6)
-
-cmake --build build --target NumbatUI -j $(sysctl -n hw.logicalcpu)
-```
-
-The compiled binary is available in `build/app/NumbatUI` on Unix
-(or `build/Release/app/` on Windows). Launch it directly:
-
-```bash
-./build/app/NumbatUI # macOS / Linux
-./build/app/NumbatUI /path/to/my_database.srctrlprj # open a project
-```
-
-The binary is a native arm64 (or x86_64) Mach-O on macOS — no X11 / XQuartz
-forwarding required, unlike the Docker image documented above.
-
-Note: this command disables both the C/C++ and Python indexing features. C/C++
-indexing has been ported to LLVM/Clang 19 and can be re-enabled by passing
-`-DBUILD_CXX_LANGUAGE_PACKAGE=ON` (which then requires the LLVM 19 packages
-listed above); it is kept off in the default build while it is stabilized.
-Python indexing remains disabled by design.
-
-### Debian package (.deb)
-
-On Debian/Ubuntu, NumbatUI can be installed as a native `.deb` package. This
-installs the GUI and indexer to `/usr/bin`, the runtime data to
-`/usr/share/numbatui`, and registers the desktop entry, MIME association
-(`*.srctrlprj`) and application icons.
-
-#### Install a prebuilt package
-
-Every push to the `main` and `dev` branches builds a `.deb` in CI. Download it
-from the **Actions** tab: open the latest *Build Debian package* run and grab
-the `numbatui-deb--` artifact (tagged `v*` releases also attach the
-`.deb` to the GitHub release). Then:
-
-```bash
-sudo apt install ./numbatui_*_amd64.deb
-```
-
-`apt` pulls in the required Qt 6 and Boost runtime libraries automatically.
-
-#### Build the package yourself
-
-From a checkout of the repository:
-
-```bash
-# one-off: install the build dependencies declared in debian/control
-sudo apt build-dep .
-# or, without a deb-src entry:
-# sudo apt install devscripts equivs && sudo mk-build-deps -i debian/control
-
-# build the binary package (the .deb is written to the parent directory)
-dpkg-buildpackage -us -uc -b
-ls ../numbatui_*_amd64.deb
-```
-
-The packaging lives in `debian/` and drives the same CMake build as above
-through `debhelper`. See [`debian/README.source`](./debian/README.source) for
-the packaging design and how to bump the package version.
-
-### Note on Docker on macOS
-
-The Docker image documented in [Usage](#usage) is Linux-only and ships a Qt
-GUI that talks to X11 / Wayland. Neither display server is native on macOS,
-so running it would require installing
-[XQuartz](https://www.xquartz.org/) and forwarding `DISPLAY=host.docker.internal:0`
-over TCP — workable, but slow and lacking a native look. We recommend the
-macOS native build above instead.
-
-## Documentation
-
-For the moment you can consult the old Sourcetrail documentation [here](./DOCUMENTATION.md), we will update it soon.
-
## Publications
N/A
diff --git a/docs/installation.md b/docs/installation.md
index dd31a63f5..8bf00ed9f 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -10,12 +10,11 @@ icon: lucide/file-terminal
NumbatUI does not yet ship prebuilt installers. There are three supported ways
to get it running, in increasing order of integration with your system:
-* the **Docker image**, which bundles every dependency and is the recommended
- way to try NumbatUI;
+* the **Docker image**, which bundles every dependency;
* a **manual build** from source on Linux or macOS;
* a native **Debian package** (`.deb`) on Debian/Ubuntu.
-## Docker (recommended)
+## Docker
The Docker image contains all required dependencies. Either build it locally: