diff --git a/.github/workflows/CITest.yml b/.github/workflows/CITest.yml index ff992074f..58213779e 100644 --- a/.github/workflows/CITest.yml +++ b/.github/workflows/CITest.yml @@ -7,9 +7,8 @@ on: - "ChangeLog" - "CREDITS.TXT" - "COMPILE_MAKE.TXT" - - "COMPILE_MSVC.TXT" - - "COMPILE_CMAKE.TXT" - - "HACK.TXT" + - "BUILDING.md" + - "CONTRIBUTING.md" - "LICENSE.TXT" - "LICENSE_LLVM.TXT" - "README.md" diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 000000000..a6d662a85 --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,89 @@ +# Building Capstone + +This guide describes how to build Capstone with `CMake`. + +## Build commands + +**Unix** + +```bash +cmake -B build -DCMAKE_BUILD_TYPE=Release # For debug build change "Release" to "Debug" +cmake --build build +cmake --install build --prefix "" +``` + +**Windows** + +```bash +cmake.exe -B build +cmake.exe --build build --config Release # For debug build change "Release" to "Debug" +cmake.exe --install build +``` + +## Tailor Capstone to your needs. + +Enable and disable options in the "configure" step (first `cmake` command from above). +Options are added with `-D