Repository navigation
docs: rework the README to the org layout and fix two false statements - #50
Merged
Merged
Conversation
Follow the layout the other cpp-linter READMEs move to: name, two badges, one sentence, a link line, then Quick start, Usage, Supported versions, Platforms, Dependencies, Environment variables, Contributing and License. Sections were H1 headings; they are H2 now. `asdf set` writes .tool-versions in the current directory, not ~/.tool-versions (that needs -u). The plugin never offers to remove the macOS quarantine attribute: the check compares against "macosx" while the platform is "macos", and curl does not set the attribute anyway, so drop ASDF_CLANG_TOOLS_MACOS_DEQUARANTINE from the README. Also say that versions are LLVM majors, that the plugin name must be the tool name, and that GITHUB_TOKEN raises the API rate limit.
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.
Part of aligning the READMEs across the org (same layout as cpp-linter/cpp-linter-hooks#289).
What changed
Header
build.yml) and part of cpp-linter.<div>, the badges inside the H1, the Lint badge and the emoji hub badge.asdf plugin addclonesmain, so nobody installs a release tag.False today, now fixed
asdf setcomment: it said the command writes~/.tool-versions. Since asdf 0.16 it writes./.tool-versions;-uwrites the home file. The Quick start now says it needs asdf 0.16 or later.lib/utils.bashchecks formacosx, but the platform ismacos, soASDF_CLANG_TOOLS_MACOS_DEQUARANTINEdoes nothing. curl does not set the quarantine attribute, and the binaries ran with no Gatekeeper prompt. The variable is removed from the README, which now says this.Clarified, each tested
clang-toolsas the name, install fails.asdf install clang-format 21.1.0fails.clang-formatexample read stdin and waited; it now runsclang-format --version.GITHUB_TOKENis now listed: the scripts send it with the release API request.Removed
Checked
clang-format --versionprinted the LLVM 23 build.Not in this PR
lib/utils.bashand its env var inbuild.yml.asdf plugin test clang-tools ...commands in CONTRIBUTING.md, which fail.