Skip to content

Commit ea6ee23

Browse files
committed
[Doc] update README.md
1 parent c8744f9 commit ea6ee23

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
@@ -6,13 +6,24 @@ Our recent development is avaiable at [our website](https://prosys.kaist.ac.kr/o
66

77
## Installation
88

9+
10+
Configure the environment variables.
11+
```bash
12+
# The LLVM project directory.
13+
# We will use the clang and llvm toolchains and libraries to build
14+
# Optimuzz, Alive2, and other LLVM versions under test.
15+
export LLVM_PATH=$HOME/llvm-project
16+
17+
# LLVM versions under test will be installed under this directory.
18+
export LLVM_BUILDS=$HOME/llvm-builds # or your favorite to store the LLVM project builds
19+
```
20+
921
The script below installs the followings:
1022
* the required OPAM packages
1123
* LLVM 20 with the OCaml bindings
1224
* Alive2
1325

1426
```bash
15-
export LLVM_PATH=$HOME/llvm-project # or your favorite
1627
build.sh
1728
```
1829

@@ -22,7 +33,6 @@ We provide following tools to employ Optimuzz.
2233

2334
```sh
2435
# Build LLVM with our instrumentation pass
25-
export LLVM_BUILDS=$HOME/llvm-builds # or your favorite to store the LLVM project builds
2636
$ tools/build.py commit <commit-sha> <target-file> [--fresh]
2737
$LLVM_BUILDS/llvm-builds/<commit-sha>/build/bin/opt
2838

0 commit comments

Comments
 (0)