From: Alexander Goussas <goussasalexander@gmail.com>
Date: Thu, 31 Oct 2024 12:29:53 +0000 (-0500)
Subject: docs: update readme
X-Git-Url: http://git.frustrated-labs.net/?a=commitdiff_plain;h=5e62428972fe5962387011038826806727983a73;p=so-test.git

docs: update readme
---

diff --git a/README.md b/README.md
index f6b4e7a..199f20f 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,30 @@
-# load-so
+# sotest
 
 A tiny interpreter for loading and testing shared libraries.
 
 ## Installation
 
+You'll need a C compiler and CMake installed.
+
+```
+git clone https://github.com/aloussase/sotest
+cd sotest
+cmake -B build -S .
+cmake --build build
+```
+
 ## Usage
 
+To spawn a REPL:
+
+```
+./build/sotest
+```
+
+To evaluate the contents of a file:
+
+```
+./build/sotest/<filename>
+```
+
 ## Demo