General update: cleaning up the README and fixes #339, #367#529
Merged
ZigRazor merged 13 commits intoZigRazor:masterfrom Sep 20, 2025
Merged
General update: cleaning up the README and fixes #339, #367#529ZigRazor merged 13 commits intoZigRazor:masterfrom
ZigRazor merged 13 commits intoZigRazor:masterfrom
Conversation
… such as pointers: Fixes ZigRazor#339. Added /bigobj for MSVC compiler.
…moved implementation and description of algorithms, redirecting the reader to the website and Deoxygen docs.
ZigRazor
requested changes
Sep 19, 2025
Owner
ZigRazor
left a comment
There was a problem hiding this comment.
It does not build, as you can see from CI/CD
Contributor
Author
|
I expect that the failure of the windows build is due to #530 which was present in prior versions of CXXGraph for me. I will investigate this further, soon. |
ZigRazor
approved these changes
Sep 20, 2025
This was
linked to
issues
Sep 20, 2025
ZigRazor
approved these changes
Sep 20, 2025
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 of changes
Why
The main motivation for this PR was to improve the experience a new user has. I have personally found the README too cluttered and providing extra information that I do not require such as the implementation of the algorithms. The README should provide a point of entry into the codebase, showing the features, not providing explanations for everything, this is the role of the website and documentation. I have added in an example into the README and moved items around so as not to obscure the core information.
Related issue
Notes for reviewers
Testing