LordMZTE/boxflow
Archived
1
1
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
Unmaintained in favor of Zenolith A universal layout engine written in Zig
This repository has been archived on 2023-12-20. You can view files and clone it, but cannot push or open issues or pull requests.
21 commits 1 branch 0 tags 162 KiB
Zig 100%
Go to file
LordMZTE f57b4413d0
chore: port to latest Zig
2023-06-29 07:45:26 +02:00
src chore: port to latest Zig 2023-06-29 07:45:26 +02:00
.gitignore feat: initial commit 2022-12-16 18:06:06 +01:00
build.zig chore: update zig 2023-04-28 14:12:16 +02:00
LICENSE feat: initial commit 2022-12-16 18:06:06 +01:00
README.md docs: add alpha software note to readme 2022-12-16 18:12:23 +01:00

README.md

Boxflow

Boxflow is a layout engine implementing flexboxes as well as others in Zig. It aims to be universally usable for applications such as GUIs and window managers.

NOTE: Boxflow is alpha software. Expect bugs and breaking changes!

Usage

To compile Boxflow, you need to use the latest master version of the Zig compiler. If Boxflow stops compiling on master Zig, please bug me about it.

If you want to use Boxflow, a good starting point is looking at src/Box.zig. It's the main interface of Boxflow. I hope to document all types extensively.

Contributing

If you would like to fix a bug or improve documentation, you're very welcome to open a PR about that.

If you'd like to add a feature, please open an issue first, so we can discuss it.

In case you have any questions, feel free to message me on matrix (@lordmzte:mzte.de), send me an email (lord@mzte.de) or DM me on discord (LordMZTE#9001) if all else fails.

Boxflow is licensed under GPL-3 to prevent spread of proprietary garbage.