diff --git a/Makefile b/Makefile index f496157..d053887 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ # ################################################################################ # # Configuration and Variables # ################################################################################ -ZIG_LOCAL := $(HOME)/.local/share/zig/0.17.0/zig +ZIG_LOCAL := $(HOME)/.local/share/zig/0.17.1/zig ZIG ?= $(shell test -x $(ZIG_LOCAL) && echo $(ZIG_LOCAL) || which zig) BUILD_TYPE ?= Debug BUILD_OPTS = -Doptimize=$(BUILD_TYPE) @@ -98,7 +98,7 @@ format: ## Format Zig files docs: ## Generate API documentation @echo "Generating API documentation..." - @$(ZIG) build docs + @$(ZIG) build docs --prefix . serve-docs: ## Serve the generated documentation on a local server @echo "Serving API documentation locally..." diff --git a/README.md b/README.md index f0db79c..8610ef9 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,14 @@

Ordered

[![Tests](https://img.shields.io/github/actions/workflow/status/CogitatorTech/ordered/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/ordered/actions/workflows/tests.yml) -[![Zig](https://img.shields.io/badge/zig-0.17.0-F7A41D?style=flat&labelColor=282c34&logo=zig)](https://ziglang.org/download/) +[![Zig](https://img.shields.io/badge/zig-0.17.1-F7A41D?style=flat&labelColor=282c34&logo=zig)](https://ziglang.org/download/) [![Release](https://img.shields.io/github/release/CogitatorTech/ordered.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/ordered/releases/latest) [![Docs](https://img.shields.io/badge/docs-read-507ec6?style=flat&labelColor=282c34&logo=read-the-docs)](https://CogitatorTech.github.io/ordered/) [![Examples](https://img.shields.io/badge/examples-view-507ec6?style=flat&labelColor=282c34&logo=zig)](https://github.com/CogitatorTech/ordered/tree/main/examples) [![Benchmark Results](https://img.shields.io/badge/benchmark%20results-view-507ec6?style=flat&labelColor=282c34&logo=github)](https://cogitatortech.github.io/benchmarks-ordered) [![License](https://img.shields.io/badge/license-MIT-007ec6?label=license&style=flat&labelColor=282c34&logo=open-source-initiative)](https://github.com/CogitatorTech/ordered/blob/main/LICENSE) -A sorted collection library for Zig +A fast sorted collection library for Zig @@ -76,7 +76,7 @@ Run the following command in the root directory of your project to download Orde zig fetch --save=ordered "https://github.com/CogitatorTech/ordered/archive/.tar.gz" ``` -Replace `` with the desired branch or release tag, like `main` (for the development version) or `v0.3.0`. +Replace `` with the desired branch or release tag, like `main` (for the development version) or `v0.3.3`. This command will download Ordered and add it to Zig's global cache and update your project's `build.zig.zon` file. ##### Zig Version Support @@ -85,7 +85,7 @@ Zig version supported by the main releases of Ordered: | Zig | Ordered Tags | |----------|--------------| -| `0.17.0` | `v0.3.x` | +| `0.17.x` | `v0.3.x` | | `0.16.0` | `v0.2.x` | | `0.15.2` | `v0.1.0` | diff --git a/build.zig b/build.zig index d6583b6..0ebca0b 100644 --- a/build.zig +++ b/build.zig @@ -21,8 +21,8 @@ pub fn build(b: *std.Build) void { const docs_step = b.step("docs", "Generate API documentation"); const install_docs = b.addInstallDirectory(.{ .source_dir = lib.getEmittedDocs(), - .install_dir = .{ .custom = b.root.joinString(b.allocator, "docs/api") catch @panic("OOM") }, - .install_subdir = "", + .install_dir = .prefix, + .install_subdir = "docs/api", }); docs_step.dependOn(&install_docs.step); diff --git a/build.zig.zon b/build.zig.zon index 60bbe19..e2dcd7e 100644 --- a/build.zig.zon +++ b/build.zig.zon @@ -1,6 +1,6 @@ .{ .name = .ordered, - .version = "0.3.2", + .version = "0.3.3", .fingerprint = 0xc3121f99b0352e1b, // Changing this has security and trust implications. .minimum_zig_version = "0.17.0", .paths = .{