cleanCppProject

cleancppproject

이것은 C ++의 프로젝트를위한 빈 프레임입니다. 프로젝트/빌드 환경 설정에 대해 많은 관심을 갖지 않고 새로운 프로젝트를 시작하는 데 도움이됩니다.

특징

• 현대적이고 간단한 Cmake 빌드 스크립트는 가독성을 위해 여러 구성 요소로 나뉩니다.
• 모든 것에 대한 제정신 및 간단한 대상 ( 대상 섹션 참조).
• Deb , RPM , Windows Installer , Bundle App , DMG 및 다양한 압축 패키지를 생성 할 수있는 Cpack 스크립트.
• Ctest를 통한 테스트.
• 캐치를 통한 단위 테스트.
• doxygen (Code + Wiki + UML 다이어그램이있는 Code + Wiki + UML 다이어그램)을 통한 문서 생성.
• 정적 분석 지원 (Clang-Tidy, CPPCheck).
• 소독제를 통한 동적 분석 도우미 (CMAKE/SONITIZERS.CMAKE 참조).
• 좋아하는 Linux 배포판, Windows 및 MacOS와 함께 작동합니다.
• Gitlab CI 및 Travis CI 구성 예제.
• 더 빠른 링크 시간을위한 Gold Linker 지원.
• 구성 또는 빌드 중에 다운로드 한 외부 종속성을 추가하기위한 도우미.
  • external/CMakeLists.txt 및 cmake/cleanCppExtension.cmake 참조하십시오

중요한 페이지

• 디자인 문서
• Todos 목록 (Doxygen 만 해당)
• 기본 디렉토리 구조
• 작업을 시작하는 방법

todo는 Todo가 어떻게 작동하는지보십시오

이것을 새 프로젝트로 변환하는 방법

 git clone https://github.com/kracejic/cleanCppProject.git yourNewProject
cd yourNewProject
mv .git .git-cleanCppProject
git init
git add .
git commit -m "first commit"

작업을 시작하는 방법에서 더.

우리와 링크를 유지하는 방법

우리는 정기적 으로이 저장소를 개선하고 있습니다. 만약 당신이 우리에게서 더 많은 것을 얻으려면 메인 레포를 뽑으십시오.

 cd yourNewProject/ 
git pull --git-dir='.git-cleanCppProject'

건축 지침

전제 조건

• Cmake 3.2 및 새로운
• C ++ 14를 지원하는 컴파일러
• git- 외부 리소스 다운로드
• 문서 용 Doxygen ( 문서의 더 많은 그래프, 더 많은 UML 다이어그램 용 Plantuml , plantuml 필요 Java)
• 정적 분석 및 서식을위한 Clang-Tools
• 다른 정적 분석에 대한 CPPCHECK

Linux의 전제 조건

• Arch Linux : sudo pacman -S cmake g++ graphviz git clang clang-tools-extra cppcheck java-runtime-common cppcheck

  • plantuml.jar를 다운로드하고 경로가 가리키는 곳에 도착하십시오.

• Ubuntu 16.04 : sudo apt-get install cmake g++ graphviz plantuml git clang clang-tidy clang-format cppcheck

Windows의 전제 조건

테스트 된 두 가지 방법 :

• MSYS2 기반

  • 최소 : pacman -S cmake g++ git
  • 추가 소프트웨어 pacman -S clang mingw-w64-x86_64-clang-tools-extra mingw-w64-x86_64-clang-analyzer doxygen
  • 문서의 그래프의 경우 c:Program FilesGraphviz to to c : program files graphviz에)를 설치하고 bin 하위 디렉토리를 경로 에 추가하고 Java ( 경로 에 빈 디렉토리가있어)를 설치하고 PlantUml JAR 파일을 다운로드하고 경로 에 있습니다.

• Microsoft Visual Studio

  • CMAKE를 설치하십시오
  • git을 설치하십시오
  • 추가 기능은 도구, Doxygen, GraphViz, Plantuml, Java와 함께 Clang을 설치하고 경로에 추가하십시오 ( 테스트되지 않음 )

MacOS의 전제 조건

• Macos Sierra brew install llvm doxygen cppcheck graphviz

Linux & MacOS를 구축하십시오

표준 Makefiles :

 mkdir build ; cd build
cmake ..
make -j8

Ninja Build Witch Clang, All+Doc을 빌드하여 Dist Folder에 설치하십시오.

 mkdir build ; cd build
cmake -GNinja -DCMAKE_CXX_COMPILER="clang++" ..
ninja all doc install

sudo make install 후 /usr 에 자체적으로 설치되는 릴리스 빌드

 mkdir build ; cd build
cmake .. -DCMAKE_INSTALL_PREFIX="/usr" -DCMAKE_BUILD_TYPE="Release"
make -j8 all
sudo make install

창을 구축하십시오

MSYS2 + 닌자를 사용하여 Windows를 작성하십시오

Windows에서는 닌자가 만드는 것보다 훨씬 빠르기 때문에 닌자를 선호해야합니다 (쉘에는 색상이 없습니다).

GCC와 함께 :

 mkdir build ; cd build
cmake -GNinja ..
ninja install

cmake -G "MSYS Makefiles" ..

Microsoft Visual Studio 14를 사용하여 Windows를 구축하십시오

먼저 Main CMakeLists.txt 에서 프로젝트 이름을 변경할 수 있습니다. 프로젝트와 함께 폴더로 이동하여 새 디렉토리를 만들고 다음과 같이 프로젝트 파일을 만듭니다.

 mkdir buildmsvc
cd buildmsvc
cmake -G "Visual Studio 14 2015" ..

이제 Visual Studio로 .sln 파일을 열 수 있습니다. 실행 가능한 대상을 마우스 오른쪽 버튼으로 클릭하고 시작 프로젝트로 설정 해야합니다. 디버그 모드에서만 실행될 때 콘솔 위도우가 너무 빨리 닫히기 때문에 디버깅없이 시작하려는 콘솔 창을 실제로 보려면 디버깅없이 시작 하려는 것입니다.

목표

참고 : 일부 대상의 가용성은 특정 실행 파일 (예 : Format Target의 Clang-Format)에 따라 다릅니다.

• 짓다
  • 모두 (대상이없는 경우 기본값)
  • 깨끗한
  • 설치 - binaries를 cmake_install_prefix 에 설치하십시오
  • 예시 적 입구 - 빌드시 절반 입술 바이너리를 빌드하십시오
  • examppp -run- 구축, 설치 및 실행 exampleapp binary (편의를 위해)
  • examppp -gdb- GDB의 예시 적 입술 바이너리를 빌드, 설치 및 실행 (편의를 위해)
  • run -alias for emailppp -run (짧게 유지하기 위해)
• 테스트
  • 확인 - 전체 테스트 스위트 실행 (Test/Cmakelists.txt 참조)
  • CheckVerbose- 전체 테스트 스위트 (Test/Cmakelists.txt 참조)를 실행하지만 더 많은 장황
  • 장치 - 단위 테스트 만 빌드 및 실행 (Test/Cmakelists.txt 참조)
  • Unitall- 이전과 동일하게 성공적인 단위 테스트 결과도 인쇄합니다.
• 릴리스
  • 패키지 - 패키지 빌드 (OS에 따라 Zip, Deb, RPM, Windows Installer)
• 여러 가지 잡다한
  • DOC- 문서 빌드 (Doxygen을 사용할 수있는 경우)
    • 문서는 build_dir/doc/doc/index.html 에서 찾을 수 있습니다
    • 설치 패키지의 일부가 되려면 doc/CMakeLists.txt 의 끝에있는 무결점 섹션
  • 형식 -모든 소스 파일에서 clang-format run (프로젝트의 루트 디렉토리에서 .clang-format가 사용됩니다)
  • GDB- GDB로 실행 가능한 실행 가능 (닌자에서 작동하지 않음, GDB 필요)
• 정적 분석
  • Tidy- 모든 소스에서 Clang 정적 분석을 실행하십시오
  • CPPCHECK- 모든 파일에서 CPPCHECK에 전화하십시오 (다른 정적 분석)
• 외부
  • 업데이트 - 모든 외부 소스/프로젝트를 업데이트하십시오

cmake 변수

• -DCMAKE_INSTALL_PREFIX 설치 위치
• -DVERSION_HOST 기계 이름 빌드, version.h.in을 참조하십시오
• -DCMAKE_BUILD_TYPE 빌드 유형의 경우
• -DMEASURE_ALL=ON/OFF 단일 스레드 빌드에 가장 잘 사용되는 모든 컴파일의 시간을 측정합니다. time 명령 (UNIX)이 필요합니다.
• -DUSE_GOLD_LINKER=ON/OFF 금 링커와 링크할지 여부.

특허

저작권 (C) 2019 Kracejic

이에 따라이 소프트웨어 및 관련 문서 파일 ( "소프트웨어")의 사본을 얻는 사람에게는 허가가 부여됩니다. 소프트웨어의 사용, 복사, 수정, 합병, 배포, 배포, 숭고 및/또는 소프트웨어의 사본을 판매 할 권한을 포함하여 제한없이 소프트웨어를 처리 할 수 ​​있도록 소프트웨어를 제공 할 권한이 없습니다.

위의 저작권 통지 및이 권한 통지는 소프트웨어의 모든 사본 또는 실질적인 부분에 포함되어야합니다.

이 소프트웨어는 상업성, 특정 목적에 대한 적합성 및 비 침해에 대한 보증을 포함하여 명시 적 또는 묵시적 보증없이 "그대로"제공됩니다. 어떠한 경우에도 저자 또는 저작권 보유자는 계약, 불법 행위 또는 기타, 소프트웨어 또는 소프트웨어의 사용 또는 기타 거래에서 발생하는 계약, 불법 행위 또는 기타의 행동에 관계없이 청구, 손해 또는 기타 책임에 대해 책임을지지 않습니다.