Skip to content
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

Add README #5

Merged
merged 6 commits into from
Dec 22, 2023
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
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Universal-Sierra-Compiler

Universal-Sierra-Compiler is the tool for Sierra compilation. It compiles any ever-existing Sierra version to CASM.

| Supported Sierra Versions |
|---------------------------|
| ~1.4.0 |
| ~1.3.0 |
| ~1.2.0 |
| 1.1.0 |
| 1.0.0 |
| 0.1.0 |

## Usage

To use the tool, just pass a path to a file with Sierra in json format:

```shell
$ universal-sierra-compiler \
--sierra-input-path ./path/to/sierra.json

{"bytecode": ...}
```
war-in marked this conversation as resolved.
Show resolved Hide resolved

> 📝 **Note**
>
> Please, note that the output is in the JSON format.

To automatically save CASM, pass `casm-output-path` argument:

```shell
$ universal-sierra-compiler \
--sierra-input-path ./path/to/sierra.json
--casm-output-path ./path/to/casm.json
```