Sourcetrail is a free and open-source cross-platform source explorer that helps you get productive on unfamiliar source code. It is:

• free
• working offline
• operating on Linux, Windows (and macOS)
• supporting C, C++ and Java
• offering an SDK (SourcetrailDB) to write custom language extensions

Binary releases are available for sponsors.

• Quick Start Guide (Version 2021.4)
• Documentation (Version 2021.4)
• Building

Sourcetrail is licensed under the GNU General Public License Version 3.

Important: This project was archived by the original autors and maintainers of Sourcetrail by the end of 2021. If you want to know more about this decision, read more in the original README.md

This is a fork of the Sourcetrail project and I want to keep this project at least buildable.

There are 2 ways to build the project:

1. With vcpkg provided packages (Vcpkg build)
2. With the system provided packages (System build)

It is important to clone the repository with the submodules and the symlinks:

# note under windows either development mode or an elevated git terminal/console is required or the git clone fails
# due to failing of symlink creation
git clone https://github.com/petermost/Sourcetrail.git --recurse-submodules --config core.symlinks=true

and get the updates with:

git pull --recurse-submodules

• In order to build the java_indexer additional software must be installed which are not provided by vcpkg:
  • OpenJDK
  • Maven
• Linux: Because Qt6 is build from source, additional packages are needed. Install these packages with script/install-qt6-dependencies.sh.
• Windows: The build must be done in a "x64 Native Tools Command Prompt for VS 2022".
• MacOS: to compile under MacOS several things have to be installed beforehand, even with vcpkg
  • XCode has to be installed
  • the following packages have to be installed via brew brew install libtools maven autoconf autoconf-archive automake patchelf ninja

Prepare the build in Windows and Linux:

$ cd Sourcetrail
$ cmake --preset vcpkg-ninja-release

Prepare the build in MacOs:

$ cd Sourcetrail
$ cmake --preset vcpkg-ninja-release-macos

Note that the initial compilation of the vcpkg packages (especially LLVM) will take a long time! Depending on your machine, it probably will take about 2 to 3 hours!

Build:

$ cd ../build/vcpkg-ninja-release
$ cmake --build .

To compile it under (K)ubuntu 24.10, "Oracular Oriole", install the following packages:

General packages: cmake, ninja-build, libboost1.83-all-dev, qt6-base-dev, qt6-svg-dev, libsqlite3-dev, libtinyxml-dev

C++ packages: clang-19, libclang-19-dev

Java packages: maven, openjdk-23-jdk

Unit test packages: catch2, libgtest-dev

Prepare the build:

$ cd Sourcetrail
$ cmake --preset system-ninja-release

Build:

$ cd ../build/system-ninja-release
$ cmake --build .

It's probably also possible to build with pre-installed libraries, like the original build instructions describe, but it's untested and unsupported.

System build was not tested under MacOS

C++

Java

Miscellaneous

Tests