Skip to content

Commit 55bc56f

Browse files
committed
docs: update README
1 parent e643c5c commit 55bc56f

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

README.markdown

+19-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
11
# 🦠 algaett’s not algaeff
22

33
This development is an experiment with the following goals:
4+
45
1. Adopt smalltt and related techniques into the cubical world.
56
2. Show how various OCaml packages of ours fit together.
67
3. Write natural grammars without neccesarily conforming to LR(k).
78
4. Use lots of Unicode emojis.
89

9-
## Smalltt
10+
## Try It Out!
11+
12+
```bash
13+
opam pin git+https://github.com/RedPRL/bantorra
14+
opam pin git+https://github.com/RedPRL/algaett
15+
cat tests/example.ag
16+
algaett tests/example.ag
17+
```
18+
19+
The last line should not have an output, which means it type checks!
20+
21+
## Important Ideas
22+
23+
### Ideas from Smalltt
1024

1125
The core NbE algorithm closely follows [András Kovács’s smalltt.](https://github.com/AndrasKovacs/smalltt)
1226
Here are some notable differences:
@@ -20,16 +34,16 @@ Here are some notable differences:
2034
The type inference from the universe 🌌 will fail, and then the type checking will be redone with 😄 unfolded to 🌌 🆙 1️⃣.
2135
3. The conversion checker is generalized to handle subtyping generated by cumulativity.
2236

23-
## Our OCaml packages
37+
### Modular Development
2438

2539
- [algaeff](https://redprl.org/algaeff/algaeff/Algaeff): reusable effects-based components
26-
- [asai](https://redprl.org/asai/asai/Asai): error messages _(not used yet)_
27-
- [bantorra](https://redprl.org/bantorra/bantorra): unit resolution _(not used yet)_
40+
- [asai](https://redprl.org/asai/asai/Asai): error messages _(not actively used yet)_
41+
- [bantorra](https://redprl.org/bantorra/bantorra): unit resolution _(not actively used yet)_
2842
- [bwd](https://redprl.org/bwd/bwd/Bwd): backward lists
2943
- [mugen](https://redprl.org/mugen/mugen/Mugen): universe levels
3044
- [yuujinchou](https://redprl.org/yuujinchou/yuujinchou): namespaces and name modifier
3145

32-
## Beyong LR
46+
### Parser beyond LR
3347

3448
We are using the Earley’s parsing algorithm which can handle all context-free grammars.
3549

test/example.ag

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
📌 😄 : 🌌 🆙 2️⃣ 👉 🌌 🆙 1️⃣
2+
📌 _ 👉 🌌 : 😄

0 commit comments

Comments
 (0)