aboutsummaryrefslogtreecommitdiff
path: root/contrib/devtools/bitcoin-tidy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/devtools/bitcoin-tidy/README.md')
-rw-r--r--contrib/devtools/bitcoin-tidy/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/contrib/devtools/bitcoin-tidy/README.md b/contrib/devtools/bitcoin-tidy/README.md
new file mode 100644
index 0000000000..c15e07c4ed
--- /dev/null
+++ b/contrib/devtools/bitcoin-tidy/README.md
@@ -0,0 +1,11 @@
+# Bitcoin Tidy
+
+Example Usage:
+
+```bash
+cmake -S . -B build -DLLVM_DIR=$(llvm-config --cmakedir) -DCMAKE_BUILD_TYPE=Release
+
+cmake --build build -j$(nproc)
+
+cmake --build build --target bitcoin-tidy-tests -j$(nproc)
+```