From 636d53fc262f415cd1bba4c4746ae1a2d169aa09 Mon Sep 17 00:00:00 2001 From: yuzu Date: Fri, 16 May 2025 02:04:06 -0500 Subject: [PATCH] fix readme aknowledging of issues present with the compilation --- README.md | 21 ++++++++++++++------- build.zig | 10 ++++------ 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5c4eb51..7ed2bec 100644 --- a/README.md +++ b/README.md @@ -71,13 +71,18 @@ pub fn main() !void { ```zig // In your build.zig file const exe = b.addExecutable(.{ - .name = "marin", + .name = "beluga", .root_source_file = b.path("src/main.zig"), .target = target, + // just a suggestion, use .ReleaseSafe .optimize = optimize, + // must always be on, hard dependency + .link_libc = true, + // self-hosted backed is unstable as of today 2025-05-16, + .use_llvm = true, }); -const dzig = b.dependency("discord.zig", .{}); +const dzig = b.dependency("discordzig", .{}); exe.root_module.addImport("discord.zig", dzig.module("discord.zig")); ``` @@ -87,18 +92,20 @@ exe.root_module.addImport("discord.zig", dzig.module("discord.zig")); ## contributing Contributions are welcome! Please open an issue or pull request if you'd like to help improve the library. * Support server: https://discord.gg/RBHkBt7nP5 -* The original repo: https://codeberg.org/yuzu/discord.zig +* The original repo: https://git.yuzucchii.xyz/yuzucchii/discord.zig ## general roadmap | Task | Status | |-------------------------------------------------------------|--------| -| stablish good sharding support w buckets and worker threads | ✅ | -| finish multi threading | ✅ | -| finish the event coverage roadmap | ✅ | -| proper error handling | ✅ | | make the library scalable with a gateway proxy | ❌ | | get a cool logo | ❌ | +## missing structures +| feature | Status | +|--------------------------|--------| +| components V2 | ❌ | +| the tags beside ur name | ❌ | + ## missing events right now | Event | Support | |----------------------------------------|---------| diff --git a/build.zig b/build.zig index 251c516..406f1fa 100644 --- a/build.zig +++ b/build.zig @@ -1,11 +1,6 @@ const std = @import("std"); -// Although this function looks imperative, note that its job is to -// declaratively construct a build graph that will be executed by an external -// runner. pub fn build(b: *std.Build) void { - // these are boiler plate code until you know what you are doing - // and you need to add additional options const target = b.standardTargetOptions(.{}); const optimize = b.standardOptimizeOption(.{}); @@ -30,6 +25,7 @@ pub fn build(b: *std.Build) void { .target = target, .optimize = optimize, .link_libc = true, + .use_llvm = true, }); marin.root_module.addImport("discord", dzig); @@ -47,9 +43,11 @@ pub fn build(b: *std.Build) void { const lib = b.addStaticLibrary(.{ .name = "discord.zig", - .root_source_file = b.path("lib/discord.zig"), + .root_source_file = b.path("src/root.zig"), .target = target, .optimize = optimize, + .link_libc = true, + .use_llvm = true, }); lib.root_module.addImport("ws", websocket.module("websocket"));