📝 update docs

This commit is contained in:
ValKmjolnir 2024-09-06 00:13:01 +08:00
parent 0dc9ad43c6
commit c9575c0284
2 changed files with 20 additions and 5 deletions

View File

@ -6,10 +6,8 @@ This is the main repository for Colgm compiler.
## Repo Content
- [Bootstrap](./bootstrap/README.md) -> bootstrap
- still under development
- [Bootstrapped [WIP]](./src/README.md) -> src
- for bootstrap test, not useful
- [bootstrap](./bootstrap/README.md): still under development
- [src](./src/README.md): for bootstrapped compiler, not available now
## Bootstrapping Compiler

View File

@ -1,6 +1,6 @@
# <img src="../doc/colgm.svg" height="50px"/> Colgm Compiler
WIP. The compiled `.ll` file maybe malfunction.
Work in progress.
## Build
@ -9,3 +9,20 @@ First you need bootstrap compiler, then use this command:
```bash
[path of the compiler] main.colgm -L .
```
And `out.ll` is generated, try `lli` or `clang`.
## Run
for `lli`(maybe crash on macOS, don't know why):
```bash
lli out.ll main.colgm -l -a
```
for `clang`:
```bash
clang out.ll -o colgm
./colgm main.colgm -l -a
```