diff options
| author | Vitaly Shukela <vi0oss@gmail.com> | 2020-06-25 18:59:46 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-25 17:59:46 +0200 |
| commit | eda840a498d1cf796d3be386c8f985ec0d17e91f (patch) | |
| tree | 851afe8c2d33e96437dc9f36d7b0e973a9c9127a | |
| parent | a3cd293148e0678074cbbec06e5d3e9159a14ea0 (diff) | |
| download | rust-eda840a498d1cf796d3be386c8f985ec0d17e91f.tar.gz rust-eda840a498d1cf796d3be386c8f985ec0d17e91f.zip | |
Longer README about how to use this instead of `cargo run` (#1054)
* Longer README about how to use this instead of `cargo run` Resolves #1052. Co-authored-by: bjorn3 <bjorn3@users.noreply.github.com>
| -rw-r--r-- | Readme.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Readme.md b/Readme.md index 1146f7e415e..23167f82bfe 100644 --- a/Readme.md +++ b/Readme.md @@ -13,14 +13,20 @@ $ ./test.sh --release ## Usage -`$cg_clif_dir` is the directory you cloned this repo into in the following instructions. +rustc_codegen_cranelift can be used as a near-drop-in replacement for `cargo build` or `cargo run` for existing projects. + +Assuming `$cg_clif_dir` is the directory you cloned this repo into and you followed the instructions (`prepare.sh` and `test.sh`). ### Cargo +In the directory with your project (where you can do the usual `cargo build`), run: + ```bash $ CHANNEL="release" $cg_clif_dir/cargo.sh run ``` +This should build and run your project with rustc_codegen_cranelift instead of the usual LLVM backend. + If you compiled cg_clif in debug mode (aka you didn't pass `--release` to `./test.sh`) you should use `CHANNEL="debug"` instead or omit `CHANNEL="release"` completely. ### Rustc |