From f835624dfba8d8812334758baac5139c83635834 Mon Sep 17 00:00:00 2001 From: Adrien Leravat Date: Fri, 14 Jun 2019 13:42:44 -0700 Subject: [PATCH] README.md: Add initial README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bfeda6e --- /dev/null +++ b/README.md @@ -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)