From 467e0a27a7dc3a15c1b6b3c3fe37177ae505f91d Mon Sep 17 00:00:00 2001 From: Tim Wojtulewicz Date: Sat, 14 Jan 2023 16:45:44 -0700 Subject: [PATCH] Add tooling section to README --- README | 13 ++++++++++++- README.md | 11 +++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/README b/README index 4698426bca..ca3a1c2103 100644 --- a/README +++ b/README @@ -85,9 +85,20 @@ License Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can find it in COPYING. +Tooling +------- + +We use the following tooling to help discover issues to fix, amongst a number of +others. + +- Clang-Tidy [5] +- Coverity [6] +- PVS-Studio - static analyzer for C, C++, C#, and Java code [7] [1] https://www.zeek.org/documentation/index.html [2] https://docs.zeek.org/en/stable/install/install.html [3] https://www.zeek.org/development/index.html [4] https://www.zeek.org/community/index.html - +[5] https://clang.llvm.org/extra/clang-tidy/ +[6] https://scan.coverity.com/projects/bro +[7] https://pvs-studio.com/en/pvs-studio/?utm_source=github&utm_medium=organic&utm_campaign=open_source \ No newline at end of file diff --git a/README.md b/README.md index 0b7489ae2f..4172789945 100644 --- a/README.md +++ b/README.md @@ -109,3 +109,14 @@ License Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can find it [here](https://github.com/zeek/zeek/blob/master/COPYING). + + +Tooling +------- + +We us the following tooling to help discover issues to fix, amongst a number of +others. + +- [Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/) +- [Coverity](https://scan.coverity.com/projects/bro) +- [PVS-Studio](https://pvs-studio.com/en/pvs-studio/?utm_source=github&utm_medium=organic&utm_campaign=open_source) - static analyzer for C, C++, C#, and Java code.