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