Updated readme, added native build option

Author: Batres3

README.md

@@ -2,8 +2,29 @@
 
 This is a fork of [glfw](https://github.com/glfw/glfw), packaged for Zig. Unnecessary files have been deleted, and the build system has been replaced with build.zig.
 
-_Looking for Zig bindings to GLFW?_ See [mach/glfw](https://github.com/hexops/mach-glfw).
+_Looking for Zig bindings to GLFW?_ See [zlfw](https://github.com/Batres3/zlfw).
 
+## Usage
+```
+git clone https://github.com/Batres3/glfw/
+cd glfw
+zig build
+```
+
+If you would like to integrate this into your own project, it is as simple as adding the dependency to `build.zig.zon`,
+and adding the following to your `build.zig`
+```
+const glfw = b.dependency("glfw", .{
+    .target = target,
+    .optimize = optimize,
+    // Additional options here
+});
+
+your_module.linkLibrary(glfw.artifact("glfw"));
+
+```
+By default, the the library adds the `include/` folder as an include path, meaning that you may access `glfw3.h` via `GLFW/glfw3.h`, however,
+if you would like access to the files in `src/` you must add the `include_src` build option.
 ## Updating
 
 To update this repository, run `./update.sh` followed by `./verify.sh` to verify the repository contents.
@@ -18,6 +39,19 @@ For supply chain security reasons (e.g. to confirm we made no patches to the cod
 
 If nothing is printed, there is no diff. Deleted files, and changes to `README.md`, `build.zig`, `.github` CI files and `.gitignore` are ignored.
 
-## Issues
-
-Issues are tracked in the [main Mach repository](https://github.com/hexops/mach/issues?q=is%3Aissue+is%3Aopen+label%3Aglfw).
+## Dependencies
+Technically, glfw has no _explicit_ dependencies and can, in theory, obtain all necessary code to compile directly from the user,
+this would include things such as vulkan headers, wayland headers and so on. However, considering that one of the main selling points of zig
+is the seamless cross compilation, it would defeat the point to use system dependencies, as such, the necessary files are included as dependencies
+in `build.zig.zon`, of those dependencies, x11, wayland and vulkan, which are public, are simple forks of the sources.
+On the other hand the macos dependencies are private, and can only be found on mac systems, I do not have access to one of these, so for
+now I am using the [mach xcode repo](https://github.com/hexops/xcode-frameworks), which is maintained by the [mach](https://machengine.org/) team
+
+However, I understand now wanting to depend on some other repo for dependencies to header file, therefore, I have added the `native` build option
+which will simply ignore the dependencies and assume that the user will provide the appropriate headers. If you are building for your own system,
+this method is entirely equivalent to the other one, however, you will not be able to cross-compile.
+
+### Wayland
+There is a caveat here for wayland, since it does not provide the headers files for many of its protocols, even when natively running wayland
+if you would like to build it natively, you may use `wayland-scanner` to do so, see [wayland-headers](https://github.com/Batres3/wayland-headers/)
+to see an example of how this is done.

build.zig

@@ -5,6 +5,7 @@ pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
 
+    const native = b.option(bool, "native", "Do not use dependencies, use system files instead") orelse false;
     const shared = b.option(bool, "shared", "Build as a shared library") orelse false;
 
     const include_src = b.option(bool, "include_src", "Add the src/ directory as an include directory") orelse false;
@@ -41,39 +42,41 @@ pub fn build(b: *std.Build) void {
     //
     // Header packaging for easy cross compilation
     //
-    if (b.lazyDependency("vulkan_headers", .{
-        .target = target,
-        .optimize = optimize,
-    })) |dep| {
-        lib.installLibraryHeaders(dep.artifact("vulkan-headers"));
-    }
-    if (target.result.os.tag == .linux) {
-        if (b.lazyDependency("x11_headers", .{
+    if (!native) {
+        if (b.lazyDependency("vulkan_headers", .{
             .target = target,
             .optimize = optimize,
         })) |dep| {
-            lib.linkLibrary(dep.artifact("x11-headers"));
-            lib.installLibraryHeaders(dep.artifact("x11-headers"));
+            lib.installLibraryHeaders(dep.artifact("vulkan-headers"));
         }
-        if (b.lazyDependency("wayland_headers", .{})) |dep| {
-            lib.addIncludePath(dep.path("wayland"));
-            lib.addIncludePath(dep.path("wayland-protocols"));
-            lib.installHeadersDirectory(dep.path("wayland"), ".", .{});
-            lib.installHeadersDirectory(dep.path("wayland-protocols"), ".", .{});
+        if (target.result.os.tag == .linux) {
+            if (b.lazyDependency("x11_headers", .{
+                .target = target,
+                .optimize = optimize,
+            })) |dep| {
+                lib.linkLibrary(dep.artifact("x11-headers"));
+                lib.installLibraryHeaders(dep.artifact("x11-headers"));
+            }
+            if (b.lazyDependency("wayland_headers", .{})) |dep| {
+                lib.addIncludePath(dep.path("wayland"));
+                lib.addIncludePath(dep.path("wayland-protocols"));
+                lib.installHeadersDirectory(dep.path("wayland"), ".", .{});
+                lib.installHeadersDirectory(dep.path("wayland-protocols"), ".", .{});
+            }
         }
-    }
-
-    if (target.result.os.tag.isDarwin()) {
-        // MacOS: this must be defined for macOS 13.3 and older.
-        lib.root_module.addCMacro("__kernel_ptr_semantics", "");
 
-        if (b.lazyDependency("xcode_frameworks", .{
-            .target = target,
-            .optimize = optimize,
-        })) |dep| {
-            lib.root_module.addSystemFrameworkPath(dep.path("Frameworks"));
-            lib.root_module.addSystemIncludePath(dep.path("include"));
-            lib.root_module.addLibraryPath(dep.path("lib"));
+        if (target.result.os.tag.isDarwin()) {
+            // MacOS: this must be defined for macOS 13.3 and older.
+            lib.root_module.addCMacro("__kernel_ptr_semantics", "");
+
+            if (b.lazyDependency("xcode_frameworks", .{
+                .target = target,
+                .optimize = optimize,
+            })) |dep| {
+                lib.root_module.addSystemFrameworkPath(dep.path("Frameworks"));
+                lib.root_module.addSystemIncludePath(dep.path("include"));
+                lib.root_module.addLibraryPath(dep.path("lib"));
+            }
         }
     }
 

build.zig.zon

@@ -7,11 +7,7 @@
         "src/",
         "build.zig",
         "build.zig.zon",
-        "CONTRIBUTORS.md",
         "LICENSE.md",
-        "README.md",
-        "update.sh",
-        "verify.sh",
     },
     .dependencies = .{
         .xcode_frameworks = .{