Skip to content

Commit

Permalink
README: add basic info
Browse files Browse the repository at this point in the history
  • Loading branch information
vaxerski authored Jun 8, 2024
1 parent bf73356 commit 5e6f630
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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`
```

0 comments on commit 5e6f630

Please sign in to comment.