The-Homebrew-Cloud/clang-format-checker-docker
2
0
Fork 0
mirror of https://github.com/wiiu-env/clang-format-checker-docker.git synced 2024-11-16 16:29:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

README.md: Add initial README

Browse Source
This commit is contained in:
Adrien Leravat 2019-06-14 13:42:44 -07:00 committed by GitHub
parent afe1fe8268
commit f835624dfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# clang-format-checker-docker
Docker image verifying the code format with clang-format
## Getting Started
Mount the source folder in the `src` working directory and run the format checker
`docker run --rm -v $(pwd):/src witekio/clang-format-checker`
The return code will be
* `1` if any formatting errors are found, and printed in the standard output.
* `0` if no issue was found
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* This Docker container uses `run-clang-format` from [https://github.com/Sarcasm/run-clang-format](https://github.com/Sarcasm/run-clang-format)