Merge pull request #1 from Techatrix/main

enhance integration with improved build options, CI, tests and cstool

Author: SoraTenshi

.gitattributes

@@ -0,0 +1,2 @@
+*.zig text eol=lf
+*.zon text eol=lf

.github/workflows/ci.yaml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        zig-version:
+          - 0.13.0
+          - master # Let's test master while it works so that breaking it is deliberate decision
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Zig
+        uses: mlugg/setup-zig@v1
+        with:
+          version: ${{ matrix.zig-version }}
+
+      - name: Check Formatting
+        run: zig fmt --ast-check --check .
+
+      - name: Build
+        run: zig build --summary all

.gitignore

@@ -1,3 +1,3 @@
-zig-out/**
-zig-cache/**
-.zig-cache/**
+zig-out
+zig-cache
+.zig-cache

README.md

@@ -1,2 +1,25 @@
+[![CI](https://github.com/allyourcodebase/capstone/actions/workflows/ci.yaml/badge.svg)](https://github.com/allyourcodebase/capstone/actions)
+
 # capstone
-This just enables to use [capstone](https://github.com/capstone-engine/capstone) as a Dependency for the Zig build system.
+
+This is [capstone](https://github.com/capstone-engine/capstone), packaged for [Zig](https://ziglang.org/).
+
+## Installation
+
+First, update your `build.zig.zon`:
+
+```
+# Initialize a `zig build` project if you haven't already
+zig init
+zig fetch --save git+https://github.com/allyourcodebase/capstone.git#5.0.1
+```
+
+You can then import `capstone` in your `build.zig` with:
+
+```zig
+const capstone_dependency = b.dependency("capstone", .{
+    .target = target,
+    .optimize = optimize,
+});
+your_exe.linkLibrary(capstone_dependency.artifact("capstone"));
+```