From e6c9bc31bfb16263e9e008b23dd484448a76b5ed Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Sun, 2 Jun 2024 11:57:19 -0700 Subject: [PATCH] mach-basisu is no longer an official project See https://github.com/hexops/mach/issues/965 Signed-off-by: Stephen Gutekanst --- config.toml | 6 - content/_index.md | 6 - content/pkg/_index.md | 6 - content/pkg/c.md | 1 - content/pkg/mach-basisu.md | 68 +-------- static/assets/mach/basisu-dark.svg | 16 -- static/assets/mach/basisu-full-dark.svg | 187 ----------------------- static/assets/mach/basisu-full-light.svg | 182 ---------------------- static/assets/mach/basisu-icon-dark.svg | 8 - static/assets/mach/basisu-icon-light.svg | 8 - static/assets/mach/basisu-light.svg | 16 -- 11 files changed, 3 insertions(+), 501 deletions(-) delete mode 100644 static/assets/mach/basisu-dark.svg delete mode 100644 static/assets/mach/basisu-full-dark.svg delete mode 100644 static/assets/mach/basisu-full-light.svg delete mode 100644 static/assets/mach/basisu-icon-dark.svg delete mode 100644 static/assets/mach/basisu-icon-light.svg delete mode 100644 static/assets/mach/basisu-light.svg diff --git a/config.toml b/config.toml index 42d2c36f..f2108d2f 100644 --- a/config.toml +++ b/config.toml @@ -221,12 +221,6 @@ unsafe = true name = 'gpu-dawn' url = '/pkg/mach-gpu-dawn' weight = 3100 -[[menu.pkg]] - identifier = 'pkg-bind-basisu' - parent = 'pkg-bind' - name = 'basisu' - url = '/pkg/mach-basisu' - weight = 3200 [[menu.pkg]] identifier = 'pkg-bind-freetype' parent = 'pkg-bind' diff --git a/content/_index.md b/content/_index.md index 432fa513..505e97a8 100644 --- a/content/_index.md +++ b/content/_index.md @@ -448,12 +448,6 @@ $ zig build -Dtarget=aarch64-macos mach-gamemode - - - - mach-basisu - - diff --git a/content/pkg/_index.md b/content/pkg/_index.md index 034bad03..85692ad3 100644 --- a/content/pkg/_index.md +++ b/content/pkg/_index.md @@ -56,12 +56,6 @@ Mach provides an ecosystem of 100% standalone, high-quality Zig gamedev packages mach-gamemode - - - - mach-basisu - - diff --git a/content/pkg/c.md b/content/pkg/c.md index eccafa38..be875c56 100644 --- a/content/pkg/c.md +++ b/content/pkg/c.md @@ -19,7 +19,6 @@ Pure forks with build.zig: * [harfbuzz](https://github.com/hexops/harfbuzz) * [freetype](https://github.com/hexops/freetype) * [glfw](https://github.com/hexops/glfw) -* [basisu](https://github.com/hexops/basisu) * [opus](https://github.com/hexops/opus) * [opusfile](https://github.com/hexops/opusfile) * [opusenc](https://github.com/hexops/opusenc) diff --git a/content/pkg/mach-basisu.md b/content/pkg/mach-basisu.md index 6acd539c..1b75ce01 100644 --- a/content/pkg/mach-basisu.md +++ b/content/pkg/mach-basisu.md @@ -7,70 +7,8 @@ docs_type: "pkg" rss_ignore: true --- -
- - - mach-basisu - - - GitHub repository | Issue tracker - -
+No longer supported as an official Mach project. The code has moved to [github.com/slimsag/mach-basisu](https://github.com/slimsag/mach-basisu) and may not be maintained to the same standard as official Mach projects. -basis universal (supercompressed textures) for Zig +**Additional details:** https://github.com/hexops/mach/issues/965 -## Experimental - -This is an **experimental** project according to [our stability guarantees](../../about/stability): - -> When a project has an experimental warning, it means all bets are off. You should carefully read the warning to understand why the project is experimental, and assume the worst. - -**Tracking issue:** https://github.com/hexops/mach/issues/965 - -## Getting started - -Create a `build.zig.zon` in your project (replace `LATEST_COMMIT` with the latest commit hash): - -```zig -.{ - .name = "mypkg", - .version = "0.1.0", - .dependencies = .{ - .mach_basisu = .{ - .url = "https://pkg.machengine.org/mach-basisu/LATEST_COMMIT.tar.gz", - }, - }, -} -``` - -Run `zig build` in your project, and the compiler will instruct you to add a `.hash = "..."` field next to `.url`: - -``` -note: expected .hash = "12209838fcfb7a77d2d6931efdc7448c033a1b7dad11d082c94bbeeba9d1038cd311", -``` - -Then use the dependency in your `build.zig`: - -```zig -pub fn build(b: *std.Build) void { - ... - exe.root_module.addImport("mach-basisu", b.dependency("mach_basisu", .{ - .target = target, - .optimize = optimize, - }).module("mach-basisu")); -} -``` - -You can now use it in your `src/main.zig` file: - -```zig -const basisu = @import("mach-basisu"); -``` - -See [this test](https://github.com/hexops/mach-basisu/blob/main/src/main.zig#L22-L47) for usage. - -### Ran into trouble? - -Triple-check you followed the `build.zig.zon` instructions correctly, it's easy to mess that part up. - -Feel free to join the [Mach Discord community](../../discord) for help. +**View the older v0.3 documentation:** https://machengine.org/v0.3/pkg/mach-basisu diff --git a/static/assets/mach/basisu-dark.svg b/static/assets/mach/basisu-dark.svg deleted file mode 100644 index 24c6e022..00000000 --- a/static/assets/mach/basisu-dark.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/static/assets/mach/basisu-full-dark.svg b/static/assets/mach/basisu-full-dark.svg deleted file mode 100644 index fcbe1370..00000000 --- a/static/assets/mach/basisu-full-dark.svg +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/static/assets/mach/basisu-full-light.svg b/static/assets/mach/basisu-full-light.svg deleted file mode 100644 index 3d0bf64b..00000000 --- a/static/assets/mach/basisu-full-light.svg +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/static/assets/mach/basisu-icon-dark.svg b/static/assets/mach/basisu-icon-dark.svg deleted file mode 100644 index 8307ddaf..00000000 --- a/static/assets/mach/basisu-icon-dark.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/static/assets/mach/basisu-icon-light.svg b/static/assets/mach/basisu-icon-light.svg deleted file mode 100644 index 5d7b5597..00000000 --- a/static/assets/mach/basisu-icon-light.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/static/assets/mach/basisu-light.svg b/static/assets/mach/basisu-light.svg deleted file mode 100644 index dc0f7589..00000000 --- a/static/assets/mach/basisu-light.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - -