Skip to content

Commit 6e5395a

Browse files
authored
Updating readme instructions (#489)
1 parent 56a022f commit 6e5395a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

Readme.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ This is a GCC codegen for rustc, which means it can be loaded by the existing ru
1212
The primary goal of this project is to be able to compile Rust code on platforms unsupported by LLVM.
1313
A secondary goal is to check if using the gcc backend will provide any run-time speed improvement for the programs compiled using rustc.
1414

15+
### Dependencies
16+
17+
**rustup:** Follow the instructions on the official [website](https://www.rust-lang.org/tools/install)
18+
1519
## Building
1620

1721
**This requires a patched libgccjit in order to work.
@@ -91,10 +95,16 @@ $ ./y.sh test --release
9195

9296
## Usage
9397

94-
`$CG_GCCJIT_DIR` is the directory you cloned this repo into in the following instructions:
98+
You have to run these commands, in the corresponding order:
9599

96100
```bash
97-
export CG_GCCJIT_DIR=[the full path to rustc_codegen_gcc]
101+
$ ./y.sh prepare
102+
$ ./y.sh build --sysroot
103+
```
104+
To check if all is working correctly, run:
105+
106+
```bash
107+
$ ./y.sh cargo build --manifest-path tests/hello-world/Cargo.toml
98108
```
99109

100110
### Cargo

0 commit comments

Comments
 (0)