Skip to content

Commit

Permalink
final readme before going to market master
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron Roller committed Apr 26, 2020
1 parent 1dc38d0 commit fe5953f
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

Github Action applying the ROS Style Guide to C++ code.

Recommended to invoke upon pull request, this will apply the code format that matches the
This Action will format the code to match the
[ROS C++ Style Guide](http://wiki.ros.org/CppStyleGuide) using
[clang-format-3.8](https://releases.llvm.org/3.8.0/tools/clang/docs/ClangFormatStyleOptions.html)
with the configuration from [davetcoleman/roscpp_code_format](https://github.com/davetcoleman/roscpp_code_format).

It is recommended to add this to `formatter.yml` that runs on `pull_request`
so it only formats when the code is stablizing and ready to merge into master.

## Usage

Expand Down Expand Up @@ -43,3 +45,8 @@ inputs:
required: false
default: 'style: Applied ROS C++ Style Guide'
```

### Override Format

Simply check in your `.clang-format` file in the root of your project and it will overwrite
the default style provided. (Not yet verified)

0 comments on commit fe5953f

Please sign in to comment.