summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMaxime Chevalier-Boisvert <[email protected]>2021-09-08 11:20:08 -0400
committerAlan Wu <[email protected]>2021-10-20 18:19:40 -0400
commit9bd6ce47454a03ad1cec422f36017bcae56790dd ()
treea72faa00c4a01f785fe0102ded0d39883ddeab7c /README.md
parent580e1bab18dbf5fd3cb2916372b0dfcfbe3b682c (diff)
Update README.md
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
@@ -52,7 +52,7 @@ git clone https://.com/Shopify/yjit
cd yjit
```
-The YJIT `ruby` binary can be built with either GCC or Clang. For development, we recommend enabling debug symbols so that assertions are enabled as this makes debugging easier. Enabling debug mode will also make it possible for you to disassemble code generated by YJIT. However, this causes a performance hit. For maximum performance, compile with GCC, without the `DRUBY_DEBUG` or `YJIT_STATS` build options. More detailed build instructions are provided in the [Ruby README](https://.com/ruby/ruby#how-to-compile-and-install.
To support disassembly of the generated code, `libcapstone` is also required (`brew install capstone` on MacOS, `sudo apt-get install -y libcapstone-dev` on Ubuntu/Debian).
```