Add readme

Signed-off-by: Pedro Falcato <[email protected]>
heatd · Nov 19, 2023 · 574d9f7 · 574d9f7
1 parent 3b05bda
commit 574d9f7
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,20 @@
+================
+HOLD - heat's Onyx link editor
+================
+
+hold is a simple ELF linker. It only works for POSIX-like platforms.
+
+Building
+================
+
+Use meson to build hold, as such::
+  meson build/
+  ninja -C build/
+
+The executable will then be at ``build/src/ld.hold``.
+
+
+Disclaimer
+================
+
+This was a fun weekend project and is very incomplete, don't expect it to work properly :)