https://github.com/karnkaul/cpp17
C++17 skeleton project featuring GitHub CI integration using CMake 3.15+, g++ 8, clang 8 and ninja 1.8+
https://github.com/karnkaul/cpp17
automated-ci ci ci-integration clang cmake cpp cpp17 github-workflow lld llvm ninja
Last synced: 3 months ago
JSON representation
C++17 skeleton project featuring GitHub CI integration using CMake 3.15+, g++ 8, clang 8 and ninja 1.8+
- Host: GitHub
- URL: https://github.com/karnkaul/cpp17
- Owner: karnkaul
- License: mit
- Created: 2019-10-19T23:28:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-20T17:17:31.000Z (over 5 years ago)
- Last Synced: 2025-01-25T06:11:21.250Z (5 months ago)
- Topics: automated-ci, ci, ci-integration, clang, cmake, cpp, cpp17, github-workflow, lld, llvm, ninja
- Language: Shell
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CPP17
[](LICENSE)
CPP17 is intended to serve as a base skeleton/framework for C++17 projects with the following features:
1. Configures via CMake
1. Integrates with GitHub Workflows for CI, which uses Ubuntu 18.04 and installs following to build:
1. cmake (3.15+)
1. g++-8
1. ninja (1.8+)
1. (Optional) clang-8, lld-8
## Usage
### Build Sample
#### Clone the repository
```
git clone https://github.com/karnkaul/CPP17
```
#### Use CMake to generate a build directory in `out/...` using `Source`
Command line:
```
CONFIG=Debug # Or Release / RelWithDebInfo / etc
cmake -G Ninja . -Bout/$CONFIG -DCMAKE_BUILD_TYPE=$CONFIG
```
GUI:
1. Select repo root as Source directory
1. Select `out/...` as the Build directory (config subdirectory not required for IDE project generators)
1. Click Configure
1. For single-configuration generators: enter the desired value for `CMAKE_BUILD_TYPE`
1. Click Generate
#### Build the project:
If using IDE project generators, open the generated project/solution/workspace in the corresponding IDE and build `BUILD_ALL`.
Command line:
```
cmake --build out/$CONFIG
```
### Use as Base Setup
1. Fork the repository in into your own account
1. Follow **Build Sample** to ensure project works
1. Replace with your source code and CMake files
## GitHub
All GitHub related files are in `.github`:
1. `workflows/ci.yml` sets up the overall workflow; edit the `on:` sections to adjust automated build triggers
1. `CI/pre-build.sh` sets up the build environment; optionally pass "TRUE" to also install `clang` and `llvm`
1. `CI/build-config.sh` builds the config passed as the first argument (`Release` if empty); pass "TRUE" as the second argument to use `/usr/bin/clang++`
### GitHub Branch Protections
In repository settings, select "Branches" and set up protections for branch wildcards to enable:
1. Prevention of branch deletions / force pushes
1. Require status checks to pass
1. After a CI Action has run, it will appear as an option here (to be selected as "Required")