aboutsummaryrefslogtreecommitdiffstats
path: root/capstone/bindings/ocaml/README
diff options
context:
space:
mode:
Diffstat (limited to 'capstone/bindings/ocaml/README')
-rw-r--r--capstone/bindings/ocaml/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/capstone/bindings/ocaml/README b/capstone/bindings/ocaml/README
new file mode 100644
index 000000000..e395232a5
--- /dev/null
+++ b/capstone/bindings/ocaml/README
@@ -0,0 +1,23 @@
+To compile Ocaml binding, Ocaml toolchain is needed. On Ubuntu Linux,
+you can install Ocaml with:
+
+ $ sudo apt-get install ocaml-nox
+
+To compile Ocaml binding, simply run "make" on the command line.
+
+
+This directory also contains some test code to show how to use Capstone API.
+
+- test_basic.ml
+ This code shows the most simple form of API where we only want to get basic
+ information out of disassembled instruction, such as address, mnemonic and
+ operand string.
+
+- test_detail.ml:
+ This code shows how to access to architecture-neutral information in disassembled
+ instructions, such as implicit registers read/written, or groups of instructions
+ that this instruction belong to.
+
+- test_<arch>.ml
+ These code show how to access architecture-specific information for each
+ architecture.