1
1
Fork 0
mirror of https://github.com/azur1s/bobbylisp.git synced 2024-10-16 02:37:40 -05:00
bobbylisp/README.md
2022-03-16 07:57:28 +07:00

73 lines
2.1 KiB
Markdown

# Hazure
Programming language that compiles to Typescript!
```sml
fun main: void = do
@write("Hello, World!");
end;
```
or with the pipe operator:
```sml
fun main: void = do
"Hello, World!\n"
|> @write(_);
end;
```
Note: Everything in this project can be changed at anytime! (I'm still finding out what work best for lots of thing) if you have an idea, feel free to create an issues about it, or even create a PR! (I'd be very happy)
# Prerequistie
- `deno`
- Rust (if you're going to build from source)
# Contributing
Found a bug? Found a better way to do something? Make a pull request or tell me in the issues tab! Anything contributions helps :D
Wanna see how it works under the hood? see the [How it works](https://github.com/azur1s/hazure#how-it-works) tab, you should probably understand it a bit more.
Steps to build:
1) Clone this repo `https://github.com/azur1s/hazure.git`
2) Build executable `cargo build`
3) Try running some examples! `path/to/executable compile path/to/file.hz`
# How it works
```
Source (.hz)
│ crates/main
Lexer produce Token
│ crates/lexer
Parser produce AST
│ crates/parser
Diagnostic(Parsing)
│ │ crates/diagnostic
│ ╰ Fail -> Print error -> Exit
Pass
Lowerer(?) produce HIR
│ crates/hir
Type Checker (TODO)
│ │
│ ╰ Fail -> Print error -> Exit
Pass
Diagnostic(Lowering)
│ │ crates/diagnostic
│ ╰ Fail -> Print error -> Exit
Pass
Codegen produce Typescript
│ crates/codegen
Done
(filename.ts)
```
# License
Hazure is licensed under both [MIT license](https://github.com/azur1s/hazure/blob/master/LICENSE-MIT) and [Apache License](https://github.com/azur1s/hazure/blob/master/LICENSE-APACHE)