Skip to content

getting_started.md

Latest commit

 

History

History
35 lines (31 loc) · 2.96 KB

getting_started.md

File metadata and controls

35 lines (31 loc) · 2.96 KB

Getting Started

  1. Install the required software as instructed in the installation guide.

  2. Modify the LICENSE file to suit your application.

  3. Modify the global variables in the CMakeLists.txt file.

  4. Change the application's splashscreen in assets/images.

  5. Change the package's icons and banners in the subdirectories of packaging.

  6. Change the application's logo in docs/doxygen.

  7. Remove the .github/FUNDING.yml file or modify it to suit your needs.

  8. Remove the CODEOWNERS file or modify it to suit your needs.

  9. Remove the CITATION.cff file or modify it to suit your needs.

  10. If using GitLab, change the path of the CI/CD configuration file in your GitLab project's Settings -> CI/CD to .gitlab/.gitlab-ci.yml.

  11. Create a new project in CDash. Edit the file CTestConfig.cmake and update the CDash badge in the README.md file accordingly.

  12. Setup your repository in Codecov. Add the following GitHub repository secret:

    • CODECOV_TOKEN: Your Codecov repository upload token.

    Update the Codecov badge in the README.md file accordingly.

  13. Setup your repository in Coveralls. Add the following GitHub repository secret:

    • COVERALLS_REPO_TOKEN: Your Coveralls token.

    Update the Coveralls badge in the README.md file accordingly.

  14. Setup your repository in Coverity scan. Add the following GitHub repository secrets:

    • COVERITY_SCAN_EMAIL: Your Coverity Scan's account e-mail.
    • COVERITY_SCAN_TOKEN: Your Coverity Scan's project token.

    Update the Coverity Scan badge in the README.md file accordingly.

  15. See the development guide to learn how to work with this template.

  16. When modifying dependencies, update .devcontainer/Dockerfile, .github workflows, and docs/install.md accordingly.

  17. For creating installers for Windows with the WiX Toolset, a unique GUID should be set for your project. In order to do this, comment the line in the CMakeLists.txt file that sets the CPACK_WIX_UPGRADE_GUID variable. After compiling the project with CMake and packaging it with WiX, as shown below, a GUID should be created for you and printed to the console. You may then use this value in the CPACK_WIX_UPGRADE_GUID variable.

    mkdir build && cd build
cmake ..
cmake --build . --config Release
cpack -G WIX