From fa3ca319e3630cd09346fb78a1acc984f8908682 Mon Sep 17 00:00:00 2001
From: Stephen D <webmaster@scd31.com>
Date: Tue, 11 Mar 2025 15:16:09 -0400
Subject: [PATCH] readme

---
 README.md                                     | 38 +++++++++++++++++++
 examples/{hello_world.sos => hello_world.lpp} |  0
 examples/{reverse.sos => reverse.lpp}         |  0
 examples/{sort.sos => sort.lpp}               |  0
 4 files changed, 38 insertions(+)
 create mode 100644 README.md
 rename examples/{hello_world.sos => hello_world.lpp} (100%)
 rename examples/{reverse.sos => reverse.lpp} (100%)
 rename examples/{sort.sos => sort.lpp} (100%)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e62947d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# λ++
+
+λ++, or Lambda Plus Plus, is small abstraction layer on top of normal lambda calculus. This project consists of a transpiler to turn λ++ into BLC (binary lambda calculus). This can then be run with a normal BLC interpreter, such as [Justine's](https://justine.lol/lambda/).
+
+## Language
+
+```
+$false=λtf.f; # definition
+$omega=λa. (a a); # definition
+
+λa.a($omega(λbcde.d(bb)(λf.fce)))$false; # main expression (which uses our definitions)
+```
+
+Basically:
+- We have comments, yay
+- Definitions can be used to abstract things (okay this is a pretty loose definition of abstraction)
+- There should be a single expression somewhere, unrelated to the definitions (this is the main expression)
+
+And that's all you get.
+
+## Examples
+
+These were all pretty much stolen from [Justine's site](https://justine.lol/lambda/). Sorry, I'm afraid I don't know what I'm doing.
+
+```bash
+$ cargo run -- examples/hello_world.lpp | ./blc
+Hello World!
+```
+
+```bash
+$ { cargo run --release -- examples/sort.lpp; echo; printf "sort this is string please"; } | ./blc
+    aeeghiiilnoprrsssssttt
+```
+
+```bash
+{ cargo run -- examples/reverse.lpp; echo; printf "hello world"; } | ./blc
+dlrow olleh
+```
diff --git a/examples/hello_world.sos b/examples/hello_world.lpp
similarity index 100%
rename from examples/hello_world.sos
rename to examples/hello_world.lpp
diff --git a/examples/reverse.sos b/examples/reverse.lpp
similarity index 100%
rename from examples/reverse.sos
rename to examples/reverse.lpp
diff --git a/examples/sort.sos b/examples/sort.lpp
similarity index 100%
rename from examples/sort.sos
rename to examples/sort.lpp
-- 
GitLab