]> git.frustrated-labs.net Git - so-test.git/commitdiff
docs: update readme
authorAlexander Goussas <[email protected]>
Thu, 31 Oct 2024 12:29:53 +0000 (07:29 -0500)
committerAlexander Goussas <[email protected]>
Thu, 31 Oct 2024 12:29:53 +0000 (07:29 -0500)
README.md

index f6b4e7ad665525224782cb52d280a3f9455dc698..199f20f205dd093bba0d0493f2febc1c6792356a 100644 (file)
--- 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