66It is a template repository that provides a pure template to make it easier to create a new AUI-based application
77project.
88
9+ ![ Screenshot] ( screenshot.png )
10+
911The main goal of this template is to speed up the setup phase of application development for both new and experienced
1012developers by preconfiguring the project scaffold and CI set up on GitHub.
1113
12- This template features:
13- - Building, testing, code quality checking and releasing with [ GitHub Actions] [ gh:actions ]
14+ This template project features:
15+ - Building, testing, code quality checking and releasing with [ GitHub Actions] ( gh:actions )
1416- Application auto updating (Windows only)
1517- AUI assets
1618- Tests
1719
1820# Getting Started
1921
20- It is worth mentioning the benefits of using GitHub Templates. By created a new project using a template, you start with
21- no history or reference to this repository.
22+ It is worth mentioning the benefits of using GitHub Templates. By created a new project using a template, you will start
23+ with no history or reference to this repository.
2224
23- # Continuous Integration
25+ ## Continuous Integration
2426
25- In this project, continuous integration relies on [ GitHub Actions] [ gh:actions ] , a set of workflows that enable
27+ In this project, continuous integration relies on [ GitHub Actions] ( gh:actions ) , a set of workflows that enable
2628automation of building, testing and releasing process.
2729
2830In the ` .github/workflows ` directory, you can find definitions for the following GitHub Actions workflows:
2931- [ Build] ( .github/workflows/build.yml )
3032 - Triggered on ` push ` and ` pull_request ` events.
33+ - Caches AUI.Boot (` ~/.aui ` ).
34+ - AUI.Boot will pull precompiled AUI binaries in most cases.
3135 - Builds the project for the supported platforms.
3236 - Runs Tests.
3337 - Generates installable packages.
@@ -38,11 +42,11 @@ In the `.github/workflows` directory, you can find definitions for the following
3842 - Performs ` valgrind ` checks on tests (dynamic analysis).
3943
4044
41- # Code Quality and Formatting
45+ ## Code Quality and Formatting
4246
4347The template includes ` .clang-format ` and ` .clang-tidy ` , the latter is used for code quality checks.
4448
45- # Release Process
49+ ## Release Process
4650
4751To create a release, simply push an update to version in ` CMakeLists.txt ` . Pipeline will create a GitHub Release Draft
4852for you. After release draft is created, perform manual review and submit release.
0 commit comments