Skip to content

Commit 78dba23

Browse files
authored
Minor fix README.md (#219)
1 parent 9b59bb5 commit 78dba23

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,14 @@ The directory structure should look like the diagram below:
3333
```
3434
Your working directory/
3535
├─ mmtk-julia/
36-
│ ├─ julia/
3736
│ └─ mmtk/
3837
├─ julia/ (should be cloned manually)
3938
└─ mmtk-core/ (optional)
4039
```
4140

4241
#### Build Julia binding in Rust
4342

44-
Before building Julia, build the binding in `mmtk-julia`. Set `MMTK_JULIA_DIR` to the absolute path containing the binding's top-level directory and build the binding by running `make release` or `make debug` from that directory.
45-
46-
We currently only support a (non-moving) Immix implementation. We hope to add support for non-moving StickyImmix and the respective moving versions of both collectors in the near future. We also only support x86_64 Linux, more architectures should also be supported in the near future.
43+
Before building Julia, set `MMTK_JULIA_DIR` to the absolute path containing the binding's top-level directory. Run `make -C $MMTK_JULIA_DIR clean` to make sure you have a fresh version of the binding, and to force it to be built when building Julia. We currently only support a (non-moving) Immix implementation. We hope to add support for non-moving StickyImmix and the respective moving versions of both collectors in the near future. We also only support x86_64 Linux, more architectures should also be supported in the near future.
4744
For a release build with debugging information, first add `debug = true` under `[profile.release]` in `mmtk/Cargo.toml`.
4845
Make sure you have the prerequisites for building [MMTk](https://github.com/mmtk/mmtk-core#requirements).
4946

@@ -67,7 +64,7 @@ export MMTK_JULIA_DIR := <path-to-mmtk-julia>
6764
export MMTK_PLAN := Immix
6865
```
6966

70-
If you have done a debug build of the binding, make sure to also set `MMTK_BUILD=debug` before building Julia.
67+
If you would like to do a debug build of the binding, make sure to also set `MMTK_BUILD=debug` before building Julia.
7168

7269
### Rust FFI bindings from Julia
7370

0 commit comments

Comments
 (0)