doc: Add README doc

2026-06-21 13:56:12 +00:00 · 2021-10-07 18:47:57 +11:00
parent 69dde8dccf
commit cb94fd151b
1 changed files with 18 additions and 0 deletions
@@ -0,0 +1,18 @@
+# SLEIGH
+
+SLEIGH is a machine language translation and disassembly engine that is leveraged as part of the Ghidra decompiler.
+
+This repository exposes a CMake build for SLEIGH so that it can be integrated into other projects.
+
+### Build
+
+```sh
+mkdir build/
+cd build/
+cmake \
+    -DCMAKE_INSTALL_PREFIX="<path where sleigh will install>" \
+    -G Ninja \
+    ../
+cmake --build .
+cmake --build . --target install
+```