docs: add comprehensive README for xcmath library#5
Merged
Conversation
- Remove unnecessary vcruntime_typeinfo.h include - Format move() method implementation - Add build configuration variables to CMakePresets.json
- Add project overview and core features - Document vector types, methods, and operations - Document matrix types, methods, and transformations - Include interpolation and serialization examples - Add build instructions and compatibility table - Reference xcmixin README style for consistency
- Change C++23 to C++20 - Update build commands without vcpkg - Update requirements to reference xcmixin submodule
- Add GitHub badges (license, release, tag, language) - Add Chinese README (README.zh-CN.md) - Add MIT LICENSE file - Update .gitignore to include new files
- Rename README.zh-CN.md to README-zh.md (matching xcmixin) - Add bidirectional links between English and Chinese README - Update .gitignore
- Add License section with link to LICENSE file - Add Roadmap section with link to TODO folder
Update copyright to include author name (Tian Li)
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
1 participant
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
Test plan