Skip to content

refactor(vcpkg): standardize vcpkg.json and resolve documentation inconsistencies#253

Merged
kcenon merged 2 commits into
mainfrom
feature/252-standardize-vcpkg-json
Dec 29, 2025
Merged

refactor(vcpkg): standardize vcpkg.json and resolve documentation inconsistencies#253
kcenon merged 2 commits into
mainfrom
feature/252-standardize-vcpkg-json

Conversation

@kcenon

@kcenon kcenon commented Dec 29, 2025

Copy link
Copy Markdown
Owner

Summary

  • Standardize vcpkg.json to follow ecosystem conventions
  • Fix documentation inconsistencies between vcpkg.json and README
  • Update package name, license, and C++ standard declarations

Changes

vcpkg.json Updates

  • Package name: common-systemkcenon-common-system
  • License: MITBSD-3-Clause (matches LICENSE file)
  • Description: Updated to reflect C++20 standard
  • Removed: Invalid builtin-baseline field
  • Dependencies: Moved gtest/benchmark from default to testing feature
  • Added: JSON schema reference, supports field for platform compatibility

Documentation Updates

  • README.md: Fixed C++17 → C++20 in overview description
  • QUICK_START.md: Updated C++ standard and compiler requirements
  • FAQ.md: Updated C++ standard, compiler versions, and example flags

Verification

  • JSON validation passed
  • CMake configuration successful
  • Compiler requirements consistent across all documents

Related Issues

Closes #252
Part of Epic #251

…inconsistencies

- Update package name from 'common-system' to 'kcenon-common-system'
- Fix license from 'MIT' to 'BSD-3-Clause' (matches LICENSE file)
- Update description to reflect C++20 standard
- Remove invalid 'builtin-baseline' field
- Move gtest and benchmark from default dependencies to 'testing' feature
- Add vcpkg JSON schema reference
- Add 'supports' field for platform compatibility
- Fix README.md to consistently state C++20 (was incorrectly C++17)

Resolves #252
- Update QUICK_START.md: C++17+ -> C++20, update compiler requirements
- Update FAQ.md: C++17 -> C++20 throughout, update compiler versions
- Align compiler flags examples with C++20 standard

Part of #252
@kcenon kcenon merged commit 86697cb into main Dec 29, 2025
22 checks passed
@kcenon kcenon deleted the feature/252-standardize-vcpkg-json branch December 29, 2025 07:58
kcenon added a commit that referenced this pull request Apr 13, 2026
…onsistencies (#253)

* refactor(vcpkg): standardize vcpkg.json format and fix documentation inconsistencies

- Update package name from 'common-system' to 'kcenon-common-system'
- Fix license from 'MIT' to 'BSD-3-Clause' (matches LICENSE file)
- Update description to reflect C++20 standard
- Remove invalid 'builtin-baseline' field
- Move gtest and benchmark from default dependencies to 'testing' feature
- Add vcpkg JSON schema reference
- Add 'supports' field for platform compatibility
- Fix README.md to consistently state C++20 (was incorrectly C++17)

Resolves #252

* docs: update QUICK_START and FAQ to reflect C++20 standard

- Update QUICK_START.md: C++17+ -> C++20, update compiler requirements
- Update FAQ.md: C++17 -> C++20 throughout, update compiler versions
- Align compiler flags examples with C++20 standard

Part of #252
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

vcpkg: Standardize vcpkg.json and resolve documentation inconsistencies

1 participant