README: add basic info

This commit is contained in:
Vaxry 2024-06-08 19:39:18 +02:00 committed by GitHub
parent bf73356d39
commit 5e6f63032a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,2 +1,14 @@
# hyprutils
Hyprland utilities library used across the ecosystem
Hyprutils is a small C++ library for utilities used across the Hypr* ecosystem.
## Stability
Hyprutils depends on the ABI stability of the stdlib implementation of your compiler. Sover bumps will be done only for hyprutils ABI breaks, not stdlib.
## Building
```sh
cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_INSTALL_PREFIX:PATH=/usr -S . -B ./build
cmake --build ./build --config Release --target all -j`nproc 2>/dev/null || getconf _NPROCESSORS_CONF`
```