Skip to content

Update CLI app docs #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Available options:
Available commands:
run Run MiniML program
compile Compile MiniML program to the provided target
print-c-runtime Print C runtime
```

```
Expand All @@ -96,7 +97,8 @@ Usage: miniml compile [FILE] [-t|--target TARGET] [-o|--output OUTPUT]

Available options:
FILE Program file path (optional)
-t,--target TARGET Compilation target (binary|llvm-ir) (default: binary)
-t,--target TARGET Compilation target (binary|llvm-ir|risc-v-asm)
(default: binary)
-o,--output OUTPUT Output file path (default: filename taken from the
MiniML program)
-h,--help Show this help text
Expand All @@ -105,6 +107,21 @@ Global options:
-d,--debug Execute in debug mode
```

```
Print C runtime

Usage: miniml print-c-runtime [-o|--output OUTPUT]

Print C runtime

Available options:
-o,--output OUTPUT Output file path (default: runtime.c)
-h,--help Show this help text

Global options:
-d,--debug Execute in debug mode
```

## Developer Documentation

**Build Requirements**
Expand Down