sgraves/cpp-build-system
1
0
Fork 0
Code Issues 2 Pull Requests Releases 1 Activity

updated README.md
All checks were successful
sgraves/cpp-build-system_mac/pipeline/head This commit looks good
Details
sgraves/cpp-build-system/pipeline/head This commit looks good
Details

Browse Source
This commit is contained in:
sgraves76
2025-10-17 22:39:52 -05:00
parent 668970f573
commit 0d828fbb50
1 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -13,17 +13,22 @@ All builds are orchestrated through project scripts — **direct CMake invocatio
--- ---
## ✨ Features ### ✨ Features
- 🧱 **Static Linux builds** using **musl-libc** inside **Alpine containers** - **Cross-Platform Build Targets**
- 🪟 **MinGW64 cross-builds** from Alpine (static except core Win32 runtime) - 🧱 **Linux (musl-libc)** — fully static binaries built inside **Alpine containers**
- 🧩 **MSYS2 builds** as fallback or for testing - 🪟 **Windows (MinGW64)** — cross-compiled from Alpine, mostly static except core Win32 runtime
- 🐳 **Alpine-based Docker environments** for reproducible builds - 🧩 **Windows (MSYS2)** — native dynamic builds for testing or fallback
- 🤖 **Single Jenkins pipeline** orchestrating Win64 + Linux x64 + Linux aarch64 - 🍎 **macOS** — native x86-64 and arm64 builds
- 🤖 **Single Jenkins pipeline** orchestrating macOS x86-64 + macOS aarch64
- 💠 **Flutter embedding support** for modern native UIs - **Build & Automation**
- 🧰 **Root-level project generator** (`create_project.sh` / `.cmd`) - 🐳 **Alpine-based Docker environments** ensure fully reproducible builds
- 🧼 Ready for `clang-format`, `clang-tidy`, and CI automation - 🤖 **Unified Jenkins pipelines** for Linux, Windows, and macOS targets
- 🧰 **Root-level project generator** (`create_project.sh` / `.cmd`) for instant scaffolding
- **Development & Integration**
- 💠 Optional **Flutter embedding** for hybrid C++/Flutter UIs
- 🧼 Integrated with **clangd**, **clang-format**, and **clang-tidy** for modern IDEs and CI
--- ---
@@ -55,7 +60,6 @@ This creates:
The new directory contains: The new directory contains:
- A preconfigured cross-platform C++ project structure - A preconfigured cross-platform C++ project structure
- A `scripts/` folder for building and packaging - A `scripts/` folder for building and packaging
- Default toolchains, configs, and dependency layout
> 🧩 After creation, you'll work entirely within your new project — **cpp-build-system** remains the master template. > 🧩 After creation, you'll work entirely within your new project — **cpp-build-system** remains the master template.
@@ -95,11 +99,8 @@ Defines your project’s **identity, features, and build behavior**:
Owns your project’s **CMake build graph** — defining what gets built and how: Owns your project’s **CMake build graph** — defining what gets built and how:
- **Targets:** Add **executables** and **libraries** (static/shared as needed) - **Targets:** Add **executables** and **libraries** (static/shared as needed)
- **Sources & includes:** Declare source lists, include paths, compiler flags, and definitions - **Sources & includes:** Declare additional source lists and include paths
- **Linkage:** Link enabled third-party dependencies (toggled in `config.sh`) - **Config & resources:** Bundle configuration files and runtime assets
- **Config & resources:** Install or bundle configuration files and runtime assets
- **Install/export:** Define `install()` rules, export targets, generate package metadata
- **Conditionals:** Wrap optional targets behind `PROJECT_ENABLE_*` feature flags
Together, `config.sh` (identity & features) and `project.cmake` (targets & wiring) define a complete, reproducible build configuration across all platforms. Together, `config.sh` (identity & features) and `project.cmake` (targets & wiring) define a complete, reproducible build configuration across all platforms.