From dcd2c190e6610f1d874fc8d35883853435e1991a Mon Sep 17 00:00:00 2001 From: Erik OShaughnessy Date: Thu, 29 May 2025 14:41:43 -0500 Subject: [PATCH] Update README.md Commented out the original ASCII art block diagram and added a Mermaid diagram to replace it. --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a4d2ee8..0cf8de0 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ Internally, the Arm Disassembly Library leverages the LLVM project. The library Firstly, the build script will first perform a shallow clone of LLVM and apply any required modifications/patches before building. Cloning and building LLVM is resource-heavy and requires ~5GB of disk space. This produces a static library build of LLVM with some minor changes that exposes methods within the MC component. Secondly, libarmdisasm is created by combining the LLVM build and armdisasm code into a shared object library. - + + +```mermaid +block-beta + columns 2 + pb["Python Bindings"] + cb["C Application"] + bparrow<[" "]>(up):1 + cbarrow<[" "]>(up):1 + a["libarmdisasm.so"]:2 + b["armdisasm.c"] + c["LLVM MC"] + + +``` Once built, the resulting shared object library `libarmdisasm` can be linked and used as a component in your own C/C++ applications. The Python package can be installed to provide bindings for your Python applications.