fix readme aknowledging of issues present with the compilation

This commit is contained in:
yuzu 2025-05-16 02:04:06 -05:00
parent 07370abeae
commit 636d53fc26
2 changed files with 18 additions and 13 deletions

View File

@ -71,13 +71,18 @@ pub fn main() !void {
```zig ```zig
// In your build.zig file // In your build.zig file
const exe = b.addExecutable(.{ const exe = b.addExecutable(.{
.name = "marin", .name = "beluga",
.root_source_file = b.path("src/main.zig"), .root_source_file = b.path("src/main.zig"),
.target = target, .target = target,
// just a suggestion, use .ReleaseSafe
.optimize = optimize, .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")); 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 ## contributing
Contributions are welcome! Please open an issue or pull request if you'd like to help improve the library. 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 * 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 ## general roadmap
| Task | Status | | 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 | ❌ | | make the library scalable with a gateway proxy | ❌ |
| get a cool logo | ❌ | | get a cool logo | ❌ |
## missing structures
| feature | Status |
|--------------------------|--------|
| components V2 | ❌ |
| the tags beside ur name | ❌ |
## missing events right now ## missing events right now
| Event | Support | | Event | Support |
|----------------------------------------|---------| |----------------------------------------|---------|

View File

@ -1,11 +1,6 @@
const std = @import("std"); 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 { 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 target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{}); const optimize = b.standardOptimizeOption(.{});
@ -30,6 +25,7 @@ pub fn build(b: *std.Build) void {
.target = target, .target = target,
.optimize = optimize, .optimize = optimize,
.link_libc = true, .link_libc = true,
.use_llvm = true,
}); });
marin.root_module.addImport("discord", dzig); marin.root_module.addImport("discord", dzig);
@ -47,9 +43,11 @@ pub fn build(b: *std.Build) void {
const lib = b.addStaticLibrary(.{ const lib = b.addStaticLibrary(.{
.name = "discord.zig", .name = "discord.zig",
.root_source_file = b.path("lib/discord.zig"), .root_source_file = b.path("src/root.zig"),
.target = target, .target = target,
.optimize = optimize, .optimize = optimize,
.link_libc = true,
.use_llvm = true,
}); });
lib.root_module.addImport("ws", websocket.module("websocket")); lib.root_module.addImport("ws", websocket.module("websocket"));