1 files changed, 35 insertions, 0 deletions
diff --git a/capstone/suite/README b/capstone/suite/README
new file mode 100644
index 000000000..fc9b59a58
--- /dev/null
+++ b/capstone/suite/README
@@ -0,0 +1,35 @@
+This directory contains some tools used by developers of Capstone project.
+Average users should ignore all the contents here.
+
+
+- arm/
+	Test some ARM's special input.
+
+- MC/
+	Input used to test various architectures & modes.
+
+- benchmark.py
+	This script benchmarks Python binding by disassembling some random code.
+
+- test_*.sh
+	Run all the tests and send the output to external file to be compared later.
+	This is useful when we want to verify if a commit (wrongly) changes
+	the disassemble result.
+
+- compile_all.sh
+	Compile Capstone for all platforms (*nix32, clang, cygwin, cross-compile) &
+	report the result as pass or fail.
+
+- fuzz.py
+	This simple script disassembles random code for all archs (or selected arch)
+	in order to find segfaults.
+
+- test_mc.sh
+    This script compares the output of Capstone with LLVM's llvm-mc with the
+	input coming from MC/. This relies on test_mc.py to do all the hard works.
+
+- x86odd.py
+	Test some tricky X86 instructions.
+
+- ppcbranch.py
+	Test some tricky branch PPC instructions.