https://github.com/nitrogenez/zig-river-config

River configuration with the power of a programming language.
https://github.com/nitrogenez/zig-river-config

configuration river riverwm utility wayland wayland-compositor zig zig-lang zig-language zig-library zig-package ziglang

Last synced: 25 days ago
JSON representation

River configuration with the power of a programming language.

• Host: GitHub
• URL: https://github.com/nitrogenez/zig-river-config
• Owner: nitrogenez
• License: bsd-3-clause
• Created: 2024-06-05T21:31:10.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-06-06T15:08:23.000Z (5 months ago)
• Last Synced: 2024-10-01T03:21:42.048Z (about 1 month ago)
• Topics: configuration, river, riverwm, utility, wayland, wayland-compositor, zig, zig-lang, zig-language, zig-library, zig-package, ziglang
• Language: Zig
• Homepage:
• Size: 21.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= zig-river-config

Andrij Glyko 

v0.3.0, 2024-06-06

:toc:

:homepage: https://github.com/nitrogenez/zig-river-config

zig-river-config is a Zig library made for 

https://github.com/riverwm/river[river] wayland compositor configuration. It provides

an API to define your configuration for the compositor while still having the 

power of a low-level, robust, and fast programming language. The version of zig-river-config is the same as

the version of https://github.com/riverwm/river[river]. zig-river-config has no 

official affiliation with the https://github.com/riverwm[riverwm] organisation.

== Warning

Keep in mind, that when working with a low-level programming language like Zig you need to

manage your resources manually. Any damage dealt to your machine is not my responsibility.

== Examples

For examples see link:src/init.zig[the default init].

== Usage

First of, run `zig fetch --save "git+https://github.com/nitrogenez/zig-river-config#COMMIT_HASH"`.

After that you need to add something like that to your build.zig:

.build.zig

[source,zig]

----

const zrc_dep = b.dependency("zig_river_config", .{ .optimize = optimize, .target = target });

your_exe.root_module.addImport("zrc", zrc_dep.module("zig-river-config"));

----

== License

This software is licensed under the 3-Clause BSD License.

See link:LICENSE[LICENSE] for more info.