Skip to content

Commit c86002d

Browse files
committed
[GR-51833] Update build instructions in CONTRIBUTING.md
PullRequest: graalpython/3177
2 parents 016ef29 + 26c084b commit c86002d

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/contributor/CONTRIBUTING.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,23 @@ The first thing you want to do is to set up [`mx`](https://github.com/graalvm/mx
1313
This is the build tool we use to develop GraalVM languages.
1414
Note that you can use any JDK, and do not need GraalVM for development.
1515
In that case you'll only be able to run without the just-in-time compiler, but that can be fine for making and testing changes that are not performance sensitive.
16+
You can also download a suitable JDK using mx:
17+
```bash
18+
mx fetch-jdk
19+
```
20+
Make sure that the `JAVA_HOME` environment variable is set.
1621

17-
Once you have `mx` on your `PATH`, you can run `mx build` in this repository.
18-
This will initially download the required dependencies next to the repository and build Python.
19-
If it succeeds without errors, you should already be able to run `mx python` and get a REPL.
20-
21-
If you just want to copy and paste some commands, these should get you started:
22-
22+
For building GraalPy, you will also need some native build tools and libraries. On a Debian based system, install:
2323
```bash
24-
git clone https://github.com/graalvm/mx.git
25-
git clone https://github.com/graalvm/graalpython.git
26-
cd graalpython
27-
../mx/mx build
28-
../mx/mx python -c "print(42)"
24+
sudo apt install build-essential libc++-12-dev zlib1g-dev cmake
2925
```
3026

27+
Lastly, download maven, extract it and include it on your `PATH`.
28+
29+
Once you have all the necessary tools, you can run `mx build` in this repository.
30+
This will initially download the required dependencies next to the repository and build Python.
31+
If it succeeds without errors, you should already be able to run `mx python` and get a REPL.
32+
3133
For development, we recommend running `mx ideinit` next.
3234
This will generate configurations for Eclipse, IntelliJ, and NetBeans so that you can open the projects in these IDEs.
3335
If you use another editor with support for the [Eclipse language server](https://github.com/eclipse/eclipse.jdt.ls) we have also had reports of useable development setups with that, but it's not something we support.

0 commit comments

Comments
 (0)