Skip to content

Commit 15bf07b

Browse files
committed
Minor updates to the getting started section of the contributing docs
1 parent 3c4db90 commit 15bf07b

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

docs/contributor/CONTRIBUTING.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,34 @@ git clone https://github.com/graalvm/mx.git
1616
```
1717
Make sure to add the `mx` directory to your `PATH`.
1818

19-
You can always use the latest stable JDK for development.
20-
You can also download a suitable JDK using mx:
19+
Use `mx` to get additional projects at the right versions.
20+
From within your `graalpython` checkout, run:
21+
```
22+
mx sforceimport
23+
```
24+
25+
You can then download a suitable JDK:
26+
```bash
27+
mx -p ../graal/vm --env ce-python fetch-jdk -A --jdk-id labsjdk-ce-latest
28+
```
29+
30+
Make sure that the `JAVA_HOME` environment variable is set:
2131
```bash
22-
mx fetch-jdk
32+
export JAVA_HOME="${HOME}/.mx/jdks/labsjdk-ce-latest
33+
```
34+
35+
(Or on Windows)
36+
```
37+
$env:JAVA_HOME="$HOME\.mx\jdks\labsjdk-ce-latest"
2338
```
24-
Make sure that the `JAVA_HOME` environment variable is set.
2539
2640
For building GraalPy, you will also need some native build tools and libraries. On a Debian based system, install:
2741
```bash
2842
sudo apt install build-essential libc++-12-dev zlib1g-dev cmake
2943
```
3044
45+
(On Windows, make sure you are running in a Visual Studio Developer Powershell, that should have everything you need.)
46+
3147
Lastly, download maven, extract it and include it on your `PATH`.
3248
3349
Once you have all the necessary tools, you can run `mx python-jvm` in this repository.
@@ -36,7 +52,8 @@ If it succeeds without errors, you should already be able to run `mx python` and
3652
3753
For development, we recommend running `mx ideinit` next.
3854
This will generate configurations for Eclipse, IntelliJ, and NetBeans so that you can open the projects in these IDEs.
39-
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.
55+
See also the documentation in mx for [setting up your IDE](https://github.com/graalvm/mx/blob/master/docs/IDE.md).
56+
If you use another editor (such as VSCode, Emacs, or Neovim) with support for the [Eclipse language server](https://github.com/eclipse/eclipse.jdt.ls) or [Apache NetBeans language server](https://marketplace.visualstudio.com/items?itemName=ASF.apache-netbeans-java), you can also get useable development setups with that, but it's not something we explicitly support.
4057
4158
## Development Layout
4259

0 commit comments

Comments
 (0)