Skip to content

Commit c5ca477

Browse files
committed
Refine the build instructions about JIT compilation
1 parent 3330d24 commit c5ca477

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,26 @@ and [SDL2_Mixer library](https://wiki.libsdl.org/SDL2_mixer) installed.
4040
* macOS: `brew install sdl2 sdl2_mixer`
4141
* Ubuntu Linux / Debian: `sudo apt install libsdl2-dev libsdl2-mixer-dev`
4242

43-
### JIT compiler
44-
The tier-2 JIT compiler in `rv32emu` leverages LLVM for powerful optimization. Therefore, the target system must have [`LLVM`](https://llvm.org/) installed, with version 17 recommended. If `LLVM` is not installed, only the tier-1 JIT compiler will be used for performance enhancement.
43+
### Experimental JIT compilation
44+
The tier-2 JIT compiler in `rv32emu` leverages LLVM for powerful optimization.
45+
Therefore, the target system must have [`LLVM`](https://llvm.org/) installed, with version 17 recommended.
46+
If `LLVM` is not installed, only the tier-1 JIT compiler will be used for performance enhancement.
4547

4648
* macOS: `brew install llvm@17`
4749
* Ubuntu Linux / Debian: `sudo apt-get install llvm-17`
4850

49-
Build the emulator.
51+
Build the emulator with experimental JIT compiler:
52+
```shell
53+
$ make ENABLE_JIT=1
54+
```
55+
56+
If you don't want the JIT compilation feature, simply build with the following:
5057
```shell
5158
$ make
5259
```
5360

61+
### Verify with prebuilt RISC-V ELF files
62+
5463
Run sample RV32I[M] programs:
5564
```shell
5665
$ make check

0 commit comments

Comments
 (0)