Repository navigation
docs(readme): restructure the README with a project header, an overview and collapsible sections - #213
Open
SizzleUnrlsd wants to merge 1 commit into
Open
docs(readme): restructure the README with a project header, an overview and collapsible sections#213SizzleUnrlsd wants to merge 1 commit into
SizzleUnrlsd wants to merge 1 commit into
Conversation
…ew and collapsible sections
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.
This PR reorganizes the README. A reader arriving from GitHub now sees first what CoreTrace does and how to try it. The reference material follows, and the long build variants are folded away.
Structure
ctracefinds, who it is for, and a capability table.demo.cand its finding, then SARIF export and a configuration file.Headings now use sentence case (
### BUILDbecomes## Build). All former anchors still resolve, except two that nothing links to, in the repository or the wiki:#ctrace, the former title;#contribute, now#contributing.#argument, the former options heading, is kept as an explicit anchor.#concurrency,#runtimeand#pythonare new short anchors to the analyzer sections.Content changes beyond the layout
--sarif. It used to say 2.0 (see fix(flawfinder): name 2.0.16, the first version with --sarif #212).--static: whenever IKOS runs, the analysis ends incomplete. For--static, this applies to C/C++ inputs only.--invokeinstead of--static --dyn.static_analysisto false, and writes its report toctrace.sarif.ctrace../build/ctrace.42ae800).Verification
<version>placeholder were not tested. The stargazers page answers 404, as it does for any repository when the visitor is not logged in.mainatce3e47d.status: okandgate.exit_code2, with no failed or unread tool, and shuts down with 202.summary.mdof the run'scoverage-reportartifact.