Skip to content

Commit a6858ab

Browse files
committed
Refactor of starknet-native-compile description
1 parent ffb66ad commit a6858ab

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -391,9 +391,8 @@ Options:
391391
### `starknet-native-compile`
392392
393393
```bash
394-
Given a Sierra file (as saved in Starknet's contract tree), extracts the sierra_program from
395-
felts into readable Sierra code, compiles it to native, and saves the result to the given output
396-
path.
394+
Given a Sierra file (as saved in Starknet's contract tree), extracts the sierra_program from it into readable Sierra code, compiles it to a shared library, and saves the result to the given output path. Keep in mind, that when specifying the
395+
output file path it should have a .so extension in Linux and a .dylib extension in Macos.
397396
398397
Usage: starknet-native-compile [OPTIONS] <PATH> <OUTPUT>
399398

src/bin/starknet-native-compile.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ use cairo_lang_starknet_classes::contract_class::ContractClass;
99
use cairo_native::executor::AotContractExecutor;
1010
use clap::Parser;
1111

12-
/// Given a Sierra file (as saved in Starknet's contract tree), extracts the sierra_program from
13-
/// felts into readable Sierra code, compiles it to native, and saves the result to the given output
14-
/// path.
12+
/// Given a Sierra file (as saved in Starknet's contract tree), extracts the sierra_program
13+
/// from it into readable Sierra code, compiles it to a shared library, and saves the result
14+
/// to the given output path. Keep in mind, that when specifying the
15+
/// output file path it should have a .so extension in Linux and a .dylib extension in Macos.
1516
#[derive(Parser, Debug)]
1617
#[clap(version, verbatim_doc_comment)]
1718
struct Args {

0 commit comments

Comments
 (0)