Sourcetrail - free and open-source interactive source explorer
Sourcetrail is a free and open-source cross-platform source explorer that helps you get productive on unfamiliar source code.
Sourcetrail is: * free * working offline * operating on Windows, macOS and Linux * supporting C, C++, Java and Python * offering an SDK (SourcetrailDB) to write custom language extensions
To setup Sourcetrail on your machine, you can either download the respective build for your operating system from our list of Releases and install it on your machine, or use one of the following package managers:
choco install sourcetrail
After your installation is complete, follow our Quick Start Guide to get to know Sourcetrail.
You can post all your feature requests and bug reports on our issue tracker.
Use the following template:
If you want to support a certain feature request or you have the same bug that another user already reported, please let us know: * post a comment with "+1" to the issue * or send an email to [email protected] with the issue ID
Building Sourcetrail requires several dependencies to be in place on your machine. However, our CMake based setup allows to disable indexing support for specific languages which reduces the number of dependencies to a minimum.
CMake v3.12 (required for Windows, Linux and MacOS)
Git (required for Windows, Linux and MacOS)
gitis added to your
PATHenvironment variable before running CMake
Visual Studio (required for Windows)
ccache (optional for Linux and MacOS)
$ ./bootstrap.sh --with-libraries=filesystem,program_options,system,date_time $ ./b2 --link=static --variant=release --threading=multi --runtime-link=static --cxxflags=-fPIC
To set up your build environment run:
$ git clone https://github.com/CoatiSoftware/Sourcetrail.git $ cd Sourcetrail $ mkdir -p build/win64 $ cd build/win64 $ cmake -G "Visual Studio 15 2017 Win64" -DBOOST_ROOT= -DQt5_DIR= ../..Hint: If you are using the CMake GUI, we recommend that you activate advanced mode. Also you may be required to add some of the defines via the "Add Entry" button.
After generating the build configuration, just open the Sourcetrail.sln file that was generated by CMake and build the Sourcetrail project.
$ cd Sourcetrail $ mkdir -p build/Release $ cd build/Release $ cmake -DCMAKE_BUILD_TYPE="Release" -DBOOST_ROOT= -DQt5_DIR= ../..
$ make Sourcetrail
bin/app/user. CMake creates symlinks within the build directory that make these directories accessible.
git checkout llvmorg-10.0.0
/binis available in your
PATHenvironmen variable and that the
JAVA_HOMEenvironment variable is set:
.../apache-maven-x.x.x/binis available in your
PATHenvironmen variable and that both
MAVEN_HOMEenvironment variables are set:
Visual Studio (required for Windows)
.Net desktop developmentworkload.
/WiX Toolset v3.11/binto your
Wix extension for Visual Studio
./script/deploy_windows.shfrom your Developer Command Prompt for Visual Studio. The script which will generate a 64bit build and packages it into a portable
.zipfile and a Wix-based Windows installer, each.
After building, run the
bundle_install.shscript within the build directory which will create a
Sourcetrail.appbundle and generate a
./setup/Linux/createPackages.shfrom the main directory, which creates both a
.AppImagepackage in the main directory. Packaging depends on linuxdeployqt.
The automated test suite of Sourcetrail is powered by Catch2. To run the tests, simply execute the
Sourcetrail_testbinary. Before executing, please make sure to set the working directory to
Sourcetrail is licensed under the GNU General Public License Version 3.
The "Sourcetrail" name is a trademark owned by Coati Software and is not included within the assets licensed under the GNU GPLv3.