From c69c286b317963d72f5e97ff9581bd5ef0fcbc25 Mon Sep 17 00:00:00 2001 From: vaxerski Date: Fri, 29 Dec 2023 20:05:45 +0100 Subject: [PATCH] readme: add build instructions --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 4ac50da..41d2abe 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,22 @@ # hyprlang + The hypr configuration language is an extremely efficient, yet easy to work with, configuration language for linux applications. It's user-friendly, easy to grasp, and easy to implement. +## Building and installation + +Building is done via CMake: +```sh +cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -S . -B ./build +cmake --build ./build --config Release --target hyprlang -j`nproc 2>/dev/null || getconf NPROCESSORS_CONF` +``` +Install with: +```sh +cmake --install ./build +``` + ## Example config ```ini