Skip to content

Commit 4afb97c

Browse files
authored
docs: update README.md to remove useless section (#269)
closes #268
1 parent 2aa86a5 commit 4afb97c

File tree

1 file changed

+3
-16
lines changed

1 file changed

+3
-16
lines changed

README.md

+3-16
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,17 @@ workflow [`step-summary`][step-summary], and Pull Request reviews (with
3333
[`tidy-review`][tidy-review] or [`format-review`][format-review]).
3434

3535
> [!WARNING]
36-
> We only support Linux runners using a Debian based Linux OS (like Ubuntu and many others).
36+
> We only support Linux runners using a Debian-based Linux OS (like Ubuntu and many others).
3737
>
3838
> MacOS and Windows runners are supported as well.
3939
40-
## What's New
41-
42-
v2
43-
44-
* Change action from using docker to composite steps
45-
* improve workflow runs times from 1m 24s (using v1) to 6-20s (for simple workflow runs).
46-
* better support for the database input option (which was broken with the docker environment in v1).
47-
* better support cross-compilation
48-
* better support 3rd party libraries
49-
* Includes many issues and enhancements. See [#87](https://github.com/cpp-linter/cpp-linter-action/issues/87) for details.
50-
51-
Refer [here](https://github.com/cpp-linter/cpp-linter-action/tree/v1) for previous versions.
52-
5340
## Usage
5441

5542
> [!NOTE]
5643
> Python 3.10 needs to be installed in the docker image if your workflow is
5744
> [running jobs in a container](https://docs.github.com/en/actions/using-jobs/running-jobs-in-a-container)
5845
> (see discussion in [#185](https://github.com/cpp-linter/cpp-linter-action/issues/185)).
59-
> Our intention is to synchronize with the default python version included with Ubuntu latest LTS releases.
46+
> Our intention is to synchronize with the default Python version included with Ubuntu's latest LTS releases.
6047
6148
Create a new GitHub Actions workflow in your project, e.g. at [.github/workflows/cpp-linter.yml](https://github.com/cpp-linter/cpp-linter-action/blob/main/.github/workflows/cpp-linter.yml)
6249

@@ -72,7 +59,7 @@ The content of the file should be in the following format.
7259
with:
7360
style: 'file' # Use .clang-format config file
7461
tidy-checks: '' # Use .clang-tidy config file
75-
# only 'update' a single comment in a pull request's thread.
62+
# only 'update' a single comment in a pull request thread.
7663
thread-comments: ${{ github.event_name == 'pull_request' && 'update' }}
7764
- name: Fail fast?!
7865
if: steps.linter.outputs.checks-failed > 0

0 commit comments

Comments
 (0)