From ea70bbb78779dd78656c6ddc25c247455fa5738b Mon Sep 17 00:00:00 2001
From: iskrim46 <93485506+hovertank3d@users.noreply.github.com>
Date: Sat, 18 Jan 2025 15:00:11 +0100
Subject: update readme

---
 README.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 91621cc..9e04002 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,6 @@
-# lzcnt.space
\ No newline at end of file
+# lzcnt.space
+source code repository of [lzcnt.space](https://lzcnt.space).
+
+## building
+if you modified log2.s, you shoud run build.sh, it builds deps/genhl and runs `go generate`. genhl requires `make`, `gcc` and `lex` to be installed.
+otherwise you can just run `go build -o lzcnt.space`
-- 
cgit v1.2.3