Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.79 KB

README.md

File metadata and controls

40 lines (29 loc) · 1.79 KB
Raw

NumbatUI: source code and graph explorer

⚠️ This fork of Sourcetrail is in active development and really unstable, we recommend to not use it before our first releases.

Numbat UI is a fork of Sourcetrail, a source code explorer that was archived in 2021. Thanks to NumbatUI, you can analyze and explore a project based on the analysis of its source code.

More generally, NumbatUI has been created to extend Sourcetrail to be able to visualize and explore any graph. We also provide a user friendly API, Numbat, to generate NumbatUI projects and so explore any kind of data.

Installation

As this fork is currently a WIP, the application should be compiled by the user. It has only be tested for Linux distributions.

Requirements

For Ubuntu/Debian distributions:

  • compilation (LLVM 17): build-essential, cmake, clang-17, libclang-17-dev
  • tooling: git, unzip, wget
  • 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

Compilation

From the NumbatUI directory:

mkdir -p build/Release
cd build/Release
cmake -DCMAKE_BUILD_TYPE="Release" -DBUILD_CXX_LANGUAGE_PACKAGE=ON -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON ../.. && make NumbatUI -j $(nproc)

The compiled binary is available in build/Release/app, this directory contains symlinks to the bin/app directory.

Documentation

For the moment you can consult the old Sourcetrail documentation here, we will update it soon.

Publications

N/A

Authors

  • Eloïse Brocas (@ebrocas), Quarkslab
  • Pascal Wu (@pwu42), during his internship at Quarkslab