Sourcetrail

来源追踪

重要提示：该项目由 Sourcetrail 的原始作者和维护者于 2021 年底存档。如果您想了解有关此决定的更多信息，请在我们的博客上阅读更多内容。

Sourcetrail 是一个免费的开源跨平台源代码浏览器，可帮助您高效地处理不熟悉的源代码。

视窗：

Linux：

链接

• 下载
• 快速入门指南
• 文档
• 变更日志

来源轨迹是：

• 自由的
• 离线工作
• 可在 Windows、macOS 和 Linux 上运行
• 支持 C、C++、Java 和 Python
• 提供 SDK (SourcetrailDB) 来编写自定义语言扩展

Patreon 上的源码追踪

开源开发和定期软件发布完全是在这些杰出赞助人的支持下才得以实现！

使用 Sourcetrail

要在您的计算机上设置 Sourcetrail，您可以从我们的版本列表中下载适合您的操作系统的相应版本并将其安装在您的计算机上，或者使用以下包管理器之一：

• 将 Chocolatey 包与choco install sourcetrail一起使用

安装完成后，请按照我们的快速入门指南来了解 Sourcetrail。

如何报告问题

您可以在我们的问题跟踪器上发布所有功能请求和错误报告。

报告

使用以下模板：

• 平台版本：
• 源码跟踪版本：
• 问题描述：
• 重现问题的步骤：

配套

如果您想支持某个功能请求，或者您遇到其他用户已报告的相同错误，请告诉我们：

• 对该问题发表带有“+1”的评论
• 或发送电子邮件至 [email protected] 并附上问题 ID

如何贡献

• 请阅读并遵循 CONTRIBUTING.md 文件中的步骤。
• 您可能需要查找标记为“好第一个问题”的问题，以找到一些要解决的初始任务。
• 如果您正在寻找有关 Sourcetrail 软件开发的更多信息，请参阅我们的 wiki。

如何建造

构建 Sourcetrail 需要在您的计算机上安装多个依赖项。但是，我们基于 CMake 的设置允许禁用对特定语言的索引支持，从而将依赖项数量降至最低。

构建基础应用程序

所需工具

• CMake v3.12（Windows、Linux 和 MacOS 需要）

  • 原因：用于为您的构建系统生成构建配置
  • 下载：https://cmake.org/download

• Git（Windows、Linux 和 MacOS 需要）

  • 原因：用于版本控制并从提交和标签自动生成 Sourcetrail 版本号
  • 下载：https://git-scm.com/download
  • 备注：在运行 CMake 之前，请确保将git添加到您的PATH环境变量中

• Visual Studio（Windows 需要）

  • 原因：用于构建Sourcetrail
  • 下载：https://visualstudio.microsoft.com/downloads/

• ccache（Linux 和 MacOS 可选）

  • 原因：如果在PATH中找到，则用于加速重建
  • 下载：https://ccache.dev/download.html

所需的依赖项

• 提升1.67

  • 原因：用于文件系统访问和进程间通信
  • 适用于 Windows 的预构建下载：https://sourceforge.net/projects/boost/files/boost-binaries/
  • 为 Unix 构建：

     $ ./bootstrap.sh --with-libraries=filesystem,program_options,system,date_time
    $ ./b2 --link=static --variant=release --threading=multi --runtime-link=static --cxxflags=-fPIC
    

• Qt 5.12.3

  • 原因：用于呈现 GUI 和启动附加（索引器）进程。
  • 预构建下载：http://download.qt.io/official_releases/qt/

建筑

在 Windows 上

• 要设置构建环境，请运行：

   $ 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=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..
  

  提示：如果您使用 CMake GUI，我们建议您激活高级模式。此外，您可能需要通过“添加条目”按钮添加一些定义。

• 生成构建配置后，只需打开 CMake 生成的 Sourcetrail.sln 文件并构建 Sourcetrail 项目。

在Unix上

• 要设置构建环境，请运行：

   $ cd Sourcetrail
  $ mkdir -p build/Release
  $ cd build/Release
  $ cmake -DCMAKE_BUILD_TYPE="Release" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..
  

• 现在开始构建：

   $ make Sourcetrail
  

跑步

• 从构建目录中运行 Sourcetrail。在执行期间 Sourcetrail 需要来自bin/app/data和bin/app/user资源。 CMake 在构建目录中创建符号链接，使这些目录可访问。

启用 C/C++ 语言支持

所需的依赖项

• LLVM/铿锵 11.0.0
  • Reason ：用于在索引源代码上运行预处理器，构建和遍历抽象语法树并生成错误消息。
  • 构建：确保检查正确的标签： git checkout llvmorg-11.0.0
  • 针对 Windows 构建：按照以下步骤构建项目。完全按照描述运行 cmake 命令。
  • 为 Unix 构建：按照此安装指南构建项目。确保使用-DLLVM_ENABLE_RTTI=ON进行构建。

建筑

• 使用这些附加选项运行 CMake：

   -DClang_DIR=<path/to/llvm_build>/lib/cmake/clang
  -DBUILD_CXX_LANGUAGE_PACKAGE=ON
  

• 如上所述构建 Sourcetrail。

启用 Java 语言支持

所需的依赖项

• JDK 1.8

  • 原因：用于构建 Java 索引器并使其可通过 JNI 从 C++ 代码调用。
  • 备注: 确保<jdk_root>/bin在PATH环境变量中可用，并且JAVA_HOME环境变量已设置：

     JAVA_HOME=<path/to/Java>/jdk1.x.x_xxx
    

• 梅文

  • 原因：在 Sourcetrail 的自动化测试中使用。
  • 备注: 确保.../apache-maven-xxx/bin在PATH环境变量中可用，并且M2_HOME和MAVEN_HOME环境变量均已设置：

     M2_HOME=.../apache-maven-x.x.x
    MAVEN_HOME=.../apache-maven-x.x.x
    

建筑

• 使用这些附加选项运行 CMake：

   -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• 如上所述构建 Sourcetrail。

启用Python语言支持

所需工具

• 7z（Windows 需要）
  • 原因：用于提取预构建的 SourcetrailPythonIndexer，该索引器在构建执行期间自动下载。

建筑

• 使用这些附加选项运行 CMake：

   -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• 如上所述构建 Sourcetrail。

创建部署包

视窗

所需工具

• Visual Studio（Windows 需要）

  • 原因：用于构建 Sourcetrail Windows 安装程序。
  • 备注：确保安装.Net desktop development工作负载。
  • 下载：https://visualstudio.microsoft.com/downloads/

• 维克斯3.11

  • 原因：用于构建sourcetrail.msi Windows 安装程序。
  • 备注: 确保将<path/to>/WiX Toolset v3.11/bin添加到PATH环境变量中。
  • 下载：https://wixtoolset.org/releases/

• Visual Studio 的 Wix 扩展

  • 原因：用于从 Visual Studio 构建环境运行 Wix。
  • 下载：https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • 原因：用于索引包附带的 java 示例项目。

• 解压缩工具

  • 原因：用于创建安装程序和便携式包的最终 zip 文件。
  • 备注: 确保将<path/to>/WinRAR添加到PATH环境变量中。

建筑

• 从 Visual Studio 的开发人员命令提示符运行./script/deploy_windows.sh 。该脚本将生成 64 位版本并将其打包为可移植的.zip文件和基于 Wix 的 Windows 安装程序。

macOS

构建后，在构建目录中运行bundle_install.sh脚本，这将创建一个Sourcetrail.app包并生成一个Sourcetrail_<version>.dmg容器。

Linux

从主目录运行./setup/Linux/createPackages.sh ，这会在主目录中创建.tar.gz和.AppImage包。打包依赖于 linuxdeployqt。

如何运行测试

Sourcetrail 的自动化测试套件由 Catch2 提供支持。要运行测试，只需执行Sourcetrail_test二进制文件即可。执行之前，请确保将工作目录设置为./bin/test 。

执照

Sourcetrail 根据 GNU 通用公共许可证第 3 版获得许可。

商标

“Sourcetrail”名称是 Coati Software 拥有的商标，不包含在 GNU GPLv3 许可的资产中。