Skip to content

Release trial follow up #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 22, 2024
Merged

Release trial follow up #41

merged 5 commits into from
Sep 22, 2024

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Sep 22, 2024

This adds a bin script to the node-binding, so that it can be installed globally (via npm i -g @cpp-linter/cpp-linter) and then executed like any other CLI tool (via cpp-linter ...).

I went through and updated the bindings' README files so the packages published to pypi and npm will have better information for end-users. The updated README files will also be included with the docs hosted on gh-pages.

The repo's root README had a cluster of badges. I re-organized the badges related to various distributions. Now, the repo README demonstrates how to install the package (through various package managers) and execute the CLI app.

I also copied over the pictures from cpp-linter action to demonstrate the example outputs on GitHub.

@2bndy5 2bndy5 added the documentation Improvements or additions to documentation label Sep 22, 2024
@2bndy5
Copy link
Collaborator Author

2bndy5 commented Sep 22, 2024

I disabled eslint checks in codacy. I don't know what version of eslint they're using, but it doesn't seem to respect the config I checked in with these changes. It may also not support monorepos; this monorepo is both a cargo workspace and a yarn workspace.


The timestamps on these commits are all messed up because my system's clock was using the wrong timezone. This always happens when I reboot from Ubuntu to Windows.

@2bndy5 2bndy5 merged commit a884312 into main Sep 22, 2024
44 of 45 checks passed
@2bndy5 2bndy5 deleted the release-trial-follow-up branch September 22, 2024 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant