aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/README.md b/README.md
index 2f78f37..d0e4995 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,13 @@ Embeddable & Hackable Lisp-2 Interpreter
There is a WebAssembly build, you can [try it online](https://mistivia.github.io/bamboo-lisp/).
-## Features
+## About
+
+**Features:**
- Lisp-2 (more like Common Lisp or Emacs Lisp)
- Lexical scoping
-- The interpreter part is ~2500 LOC (excluding built-in functions)
+- A small but extensible core
- Tail call optimization
- Any C99 compiler should work
- A simple mark-sweep GC
@@ -21,25 +23,21 @@ There is a WebAssembly build, you can [try it online](https://mistivia.github.io
- break
- continue
-## Drawbacks
+**Drawbacks:**
To keep simplicity, Bamboo Lisp is a VERY SLOW tree-walking interpreter. The performance is similar to other small Lisp interpreters like TinyScheme or very early Emacs Lisp, which is only 1/5 to 1/10 that of modern Python.
-## Build
-
-Install dependency first, see [algds](https://github.com/mistivia/algds) for details.
+**Summary:**
-Debug:
+If you want a TinyScheme-like embeddable lisp intereter but in Lisp-2 flavour, Bamboo Lisp is for you.
-```bash
-make
-```
+## Build
-Release:
+Install dependency first, see [algds](https://github.com/mistivia/algds) for details.
```bash
-make clean
make mode=release
+sudo make install
```
## Usage