diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..eff4f5f --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +clang-format +============ + +[](https://github.com/egor-tensin/clang-format/actions/workflows/test.yml) + +This GitHub action runs `clang-format` on your C/C++ source files and shows the +diff. + +Use it in your workflow like this: + + - name: clang-format + uses: egor-tensin/clang-format@v1 + +API +--- + +| Input | Value | Default | Description +| ------- | ------- | ------- | ----------- +| version | *empty* | ✓ | Use `clang-format`. +| | *any* | | Use `clang-format-VERSION`. +| style | file | ✓ | Use .clang-format. +| | *any* | | `-style=STYLE` (Microsoft, LLVM, etc.). +| exclude | *empty* | ✓ | Don't exclude any files. +| | *any* | | List of files and directories to exclude, separated by a colon `:`. + +| Output | Description +| ------ | ----------- +| diff | Diff between the original and the properly formatted files. + +License +------- + +Distributed under the MIT License. +See [LICENSE.txt] for details. + +[LICENSE.txt]: LICENSE.txt |