updates to readme and CMakeLists.txt #6
Merged
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the project structure to improve documentation, build configuration, and development setup. The changes focus on making the project more accessible to new users and organizing dependencies more effectively.
- Comprehensive README rewrite with detailed installation instructions for macOS, Linux, and Windows
- Reorganization of Python dependencies into optional dev dependencies
- Addition of Python type stubs file for the C++ extension module
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Complete rewrite with detailed quickstart guides for all platforms and project overview |
| pyproject.toml | Moved pytest and mypy to optional dev dependencies, updated pybind11 version constraint |
| src/demo/cppcore.pyi | Added Python type stubs for C++ extension functions |
| CMakeLists.txt | Refactored include directories and library linking for better organization |
| .github/workflows/wheels.yml | Added cibuildwheel test configuration |
| .github/workflows/test.yml | Updated to install dev dependencies |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
This PR refactors the project structure to improve documentation, build configuration, and development setup. The changes focus on making the project more accessible to new users and organizing dependencies more effectively.