Sourcetrail

중요 참고: 이 프로젝트는 2021년 말에 Sourcetrail의 원저자와 유지관리자에 의해 보관되었습니다. 이 결정에 대해 더 알고 싶으시면 저희 블로그에서 더 읽어보세요.

Sourcetrail은 무료 오픈소스 크로스 플랫폼 소스 탐색기로, 익숙하지 않은 소스 코드에서 생산성을 높이는 데 도움을 줍니다.

Windows:

Linux:

링크

• 다운로드
• 빠른 시작 가이드
• 문서
• 변경 로그

Sourcetrail은 다음과 같습니다:

• 무료
• 오프라인 작동
• Windows, macOS 및 Linux에서 작동
• C, C++, Java 및 Python 지원
• 사용자 정의 언어 확장을 작성할 수 있는 SDK (SourcetrailDB) 제공

Patreon의 Sourcetrail

오픈소스 개발과 정기적인 소프트웨어 릴리스는 이 멋진 후원자들의 지원 덕분에 이루어집니다!

Sourcetrail 사용하기

Sourcetrail을 컴퓨터에 설치하려면 릴리스 목록에서 운영 체제에 맞는 빌드를 다운로드하여 설치하거나 다음 패키지 관리자 중 하나를 사용할 수 있습니다:

• choco install sourcetrail과 함께 Chocolatey 패키지 사용

설치가 완료되면 빠른 시작 가이드를 따라 Sourcetrail을 익혀보세요.

이슈 보고 방법

모든 기능 요청 및 버그 보고는 이슈 트래커에 게시할 수 있습니다.

보고하기

다음 템플릿을 사용하세요:

• 플랫폼 버전:
• Sourcetrail 버전:
• 문제 설명:
• 문제 재현 단계:

지원하기

특정 기능 요청을 지원하거나 다른 사용자가 이미 보고한 동일한 버그가 있는 경우 알려주세요:

• 이슈에 "+1" 댓글을 게시하세요
• 또는 이슈 ID와 함께 [email protected]으로 이메일을 보내주세요

기여 방법

• CONTRIBUTING.md 파일의 단계를 읽고 따라주세요.
• 초기 작업을 위해 good first issue 레이블이 있는 이슈를 찾아보세요.
• Sourcetrail 소프트웨어 개발에 대한 더 많은 정보를 원하시면 위키를 참조하세요.

빌드 방법

Sourcetrail을 빌드하려면 컴퓨터에 여러 종속성이 필요합니다. 그러나 CMake 기반 설정을 사용하면 특정 언어에 대한 인덱싱 지원을 비활성화하여 종속성 수를 최소로 줄일 수 있습니다.

기본 애플리케이션 빌드

필요한 도구

• CMake v3.12 (required for Windows, Linux and MacOS)

  • 이유: 빌드 시스템에 대한 빌드 구성을 생성하는 데 사용
  • 다운로드: https://cmake.org/download

• Git (required for Windows, Linux and MacOS)

  • 이유: 버전 관리 및 커밋과 태그에서 Sourcetrail 버전 번호를 자동 생성하는 데 사용
  • 다운로드: https://git-scm.com/download
  • 참고: CMake를 실행하기 전에 git이 PATH 환경 변수에 추가되었는지 확인하세요.

• Visual Studio (required for Windows)

  • 이유: Sourcetrail 빌드에 사용
  • 다운로드: https://visualstudio.microsoft.com/downloads/

• ccache (optional for Linux and MacOS)

  • 이유: PATH에 있으면 재빌드 속도를 높이는 데 사용
  • 다운로드: https://ccache.dev/download.html

필요한 종속성

• Boost 1.67

  • 이유: 파일 시스템 액세스 및 프로세스 간 통신에 사용
  • Windows용 사전 빌드 다운로드: https://sourceforge.net/projects/boost/files/boost-binaries/
  • Unix에서 빌드:
    root@kitploit:~

    $ ./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에서

• 빌드 환경을 설정하려면 다음을 실행하세요:

  root@kitploit:~

  $ 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에서

• 빌드 환경을 설정하려면 다음을 실행하세요:
  root@kitploit:~

  $ 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> ../..
  

• 이제 다음으로 빌드를 시작하세요:
  root@kitploit:~

  $ make Sourcetrail
  

실행

• 빌드 디렉토리 내에서 Sourcetrail을 실행하세요. 실행 중에 Sourcetrail은 bin/app/data 및 bin/app/user의 리소스가 필요합니다. CMake는 빌드 디렉토리 내에 이러한 디렉토리에 접근할 수 있는 심볼릭 링크를 생성합니다.

C/C++ 언어 지원 활성화

필요한 종속성

• LLVM/Clang 11.0.0
  • 이유: 인덱싱된 소스 코드에 전처리기를 실행하고, 추상 구문 트리를 구축 및 탐색하며 오류 메시지를 생성하는 데 사용됨.
  • 빌드: 올바른 태그를 체크아웃해야 합니다: git checkout llvmorg-11.0.0
  • Windows에서 빌드: 이 단계를 따라 프로젝트를 빌드하세요. 설명된 대로 cmake 명령을 정확히 실행하세요.
  • Unix에서 빌드: 이 설치 가이드를 따라 프로젝트를 빌드하세요. -DLLVM_ENABLE_RTTI=ON으로 빌드해야 합니다.

빌드

• 다음 추가 옵션으로 CMake를 실행하세요:
  root@kitploit:~

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

• 위에서 설명한 대로 Sourcetrail을 빌드하세요.

Java 언어 지원 활성화

필요한 종속성

• JDK 1.8

  • 이유: Java 인덱서를 빌드하고 JNI를 통해 C++ 코드에서 호출 가능하게 하는 데 사용됨.
  • 참고: PATH 환경 변수에 <jdk_root>/bin이 있고 JAVA_HOME 환경 변수가 설정되어 있는지 확인하세요:
    root@kitploit:~

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

• Maven

  • 이유: Sourcetrail 자동화 테스트에서 사용됨.
  • 참고: PATH 환경 변수에 .../apache-maven-x.x.x/bin이 있고 M2_HOME 및 MAVEN_HOME 환경 변수가 모두 설정되어 있는지 확인하세요:
    root@kitploit:~

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

빌드

• 다음 추가 옵션으로 CMake를 실행하세요:
  root@kitploit:~

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• 위에서 설명한 대로 Sourcetrail을 빌드하세요.

Python 언어 지원 활성화

필요한 도구

• 7z (required for Windows)
  • 이유: 빌드 실행 중 자동으로 다운로드되는 사전 빌드된 SourcetrailPythonIndexer를 추출하는 데 사용됨.

빌드

• 다음 추가 옵션으로 CMake를 실행하세요:
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• 위에서 설명한 대로 Sourcetrail을 빌드하세요.

배포 패키지 생성

Windows

필요한 도구

• Visual Studio (required for Windows)

  • 이유: Sourcetrail Windows 설치 프로그램을 빌드하는 데 사용됨.
  • 참고: .Net 데스크톱 개발 워크로드를 설치해야 합니다.
  • 다운로드: https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • 이유: sourcetrail.msi Windows 설치 프로그램을 빌드하는 데 사용됨.
  • 참고: PATH 환경 변수에 <path/to>/WiX Toolset v3.11/bin을 추가해야 합니다.
  • 다운로드: https://wixtoolset.org/releases/

• Wix extension for Visual Studio

  • 이유: Visual Studio 빌드 환경에서 Wix를 실행하는 데 사용됨.
  • 다운로드: https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • 이유: 패키지에 포함된 Java 샘플 프로젝트를 인덱싱하는 데 사용됨.

• WinRAR

  • 이유: 설치 프로그램 및 휴대용 패키지의 최종 zip 파일을 만드는 데 사용됨.
  • 참고: PATH 환경 변수에 <path/to>/WinRAR을 추가해야 합니다.

빌드

• 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 General Public License 버전 3에 따라 라이선스가 부여됩니다.

상표

"Sourcetrail" 이름은 Coati Software가 소유한 상표이며 GNU GPLv3에 따라 라이선스가 부여된 자산에 포함되지 않습니다.