From c6813db0972c54c058cfc58cd2655a3e79c16301 Mon Sep 17 00:00:00 2001
From: Stepan Usatiuk <stepus53@gmail.com>
Date: Thu, 4 Jan 2024 00:23:12 +0100
Subject: [PATCH] some docs

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb5f97d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# PSIL
+
+a simple lisp interpreter
+
+## How to compile
+
+Should be a regular cmake build, something like
+
+```shell
+cmake -B build -DCMAKE_BUILD_TYPE=Debug -DSANITIZE=YES
+cmake --build build  --parallel $(nproc)
+```
+
+should be enough (you can also change the build type for Release and disable sanitize in case it's too slow)
+
+## How to run tests
+
+Unit tests (assuming build in `build`):
+
+```shell
+ctest --test-dir build --verbose --parallel $(nproc)
+```
+
+CLI tests (also assuming build in `build` and being in repo root):
+
+```shell
+PSIL="../build/src/psil" clitests/testall.sh
+```