]> git.frustrated-labs.net Git - so-test.git/commitdiff
docs: update readme
authorAlexander Goussas <[email protected]>
Fri, 1 Nov 2024 12:57:01 +0000 (07:57 -0500)
committerAlexander Goussas <[email protected]>
Fri, 1 Nov 2024 12:57:01 +0000 (07:57 -0500)
README.md

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