msyds/rlp
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 2 Wiki Activity

update readme

Browse Source
This commit is contained in:
crumbtoo
2024-02-13 12:57:01 -07:00
parent 4c9ceb74d1
commit c57da862ae
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -26,12 +26,14 @@ $ cabal test --test-show-details=direct
#### TLDR #### TLDR
```sh ```sh
# Compile and evaluate examples/factorial.cr, with evaluation info dumped to stderr # Compile and evaluate examples/rlp/QuickSort.rl
$ rlpc -ddump-eval examples/factorial.cr $ rlpc examples/QuickSort.rl
# Compile and evaluate t.cr, with evaluation info dumped to t.log # Compile and evaluate t.cr, with evaluation info dumped to t.log
$ rlpc -ddump-eval -l t.log t.cr $ rlpc -ddump-eval -l t.log t.cr
# Compile and evaluate t.rl, dumping the desugared Core # Compile and evaluate t.rl, dumping the desugared Core
$ rlpc -ddump-desugared t.rl $ rlpc -ddump-desugared t.rl
# Compile and evaluate t.rl with all compiler messages enabled
$ rlpc -dALL t.rl
``` ```
#### Options #### Options
@@ -126,7 +128,7 @@ parsing remains.
- [x] Garbage Collection - [x] Garbage Collection
- [ ] Stable documentation for the evaluation model - [ ] Stable documentation for the evaluation model
### February Release Plan ### ~~February Release Plan~~
- [x] Beta rl' to Core - [x] Beta rl' to Core
- [x] UX improvements - [x] UX improvements
- [x] Actual compiler errors -- no more unexceptional `error` calls - [x] Actual compiler errors -- no more unexceptional `error` calls
@@ -134,12 +136,14 @@ parsing remains.
- [x] Annotate the AST with token positions for errors (NOTE: As of Feb. 1, - [x] Annotate the AST with token positions for errors (NOTE: As of Feb. 1,
this has been done, but the locational info is not yet used in error messages) this has been done, but the locational info is not yet used in error messages)
- [x] Compiler architecture diagram - [x] Compiler architecture diagram
- [ ] More examples - [x] More examples
### March Release Plan ### March Release Plan
- [ ] Tests - [ ] Tests
- [ ] rl' parser - [ ] rl' parser
- [ ] rl' lexer - [ ] rl' lexer
- [ ] Ditch TTG in favour of a simpler AST focusing on extendability via Fix, Free,
Cofree, etc. rather than boilerplate-heavy type families
### Indefinite Release Plan ### Indefinite Release Plan
@@ -150,8 +154,6 @@ than the other release plans.
- [ ] Complete all TODOs - [ ] Complete all TODOs
- [ ] Replace mtl with effectful - [ ] Replace mtl with effectful
- [ ] rl' type-checker - [ ] rl' type-checker
- [ ] Ditch TTG in favour of a simpler AST focusing on extendability via Fix, Free,
Cofree, etc. rather than boilerplate-heavy type families
- [ ] Stable rl' to Core - [ ] Stable rl' to Core
- [ ] Core polish - [ ] Core polish
- [ ] Better, stable parser - [ ] Better, stable parser
@@ -160,3 +162,4 @@ than the other release plans.
- [ ] Less hacky pragmas - [ ] Less hacky pragmas
- [ ] Choose a target. LLVM, JS, C, and WASM are currently top contenders - [ ] Choose a target. LLVM, JS, C, and WASM are currently top contenders
- [ ] https://proglangdesign.net/wiki/challenges - [ ] https://proglangdesign.net/wiki/challenges