Merged
Conversation
This commit addresses issue #13 by updating the repository documentation to reflect the current state of the project and removing outdated references. Changes to README.md: - Remove ThemeParser references and update to AdvancedTheme - Update theming section with actual APIs (Color, ThemeManager, AdvancedTheme) - Move Roadmap to reference GitHub issues as authoritative source - Clarify that adapters are example implementations, not core framework - Fix code examples to use correct Scene-based architecture - Verify all code examples are accurate and compilable - Emphasize Scene as the root of the UI hierarchy New CONTRIBUTING.md: - Document development environment requirements (C++20, CMake, Ninja, mise) - Document building with mise and manual CMake commands - Document development workflow (mise format, test, demo) - Document code style guidelines (CRTP, header-only, relative coordinates) - Document pull request process - Emphasize NEVER bypassing git hooks, iwyu, or clang-format All documentation now accurately reflects the actual codebase structure and provides clear guidance for contributors.
- Correctly identify that project uses hk (https://github.com/jdx/hk) - Remove mention of non-existent commit-msg hook - Remove mention of iwyu in pre-commit hook (only clang-format runs) - Document that hk.pkl defines the hook configuration - Update installation instructions to use 'hk install' - Clarify that only C++ files are checked by the hook
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates repository documentation to reflect the current state of the project and removes outdated references.
Fixes #13
Changes Made
README.md Updates
CONTRIBUTING.md (New File)
Created comprehensive contributing guide with:
Files Changed
README.md- 105 insertions, 74 deletionsCONTRIBUTING.md- 513 lines (new file)Testing
Acceptance Criteria