From: Alexander Goussas <goussasalexander@gmail.com>
Date: Fri, 1 Nov 2024 12:57:01 +0000 (-0500)
Subject: docs: update readme
X-Git-Url: http://git.frustrated-labs.net/?a=commitdiff_plain;h=ee376bb34285af42e1e400ec0aaf96c9ba8f6470;p=so-test.git

docs: update readme
---

diff --git a/README.md b/README.md
index 199f20f..f5a49a4 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ You'll need a C compiler and CMake installed.
 ```
 git clone https://github.com/aloussase/sotest
 cd sotest
-cmake -B build -S .
+cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
 cmake --build build
 ```
 
@@ -24,7 +24,18 @@ To spawn a REPL:
 To evaluate the contents of a file:
 
 ```
-./build/sotest/<filename>
+./build/sotest <filename>
 ```
 
+Replace `<filename>` with the name of your script. You can use the included
+`test.sc` script to test the interpreter if you want.
+
 ## Demo
+
+### Interactive mode
+
+![interactive](./assets/interactive-mode.png)
+
+### Batch mode
+
+![batch](./assets/batch-mode.png)
\ No newline at end of file