Skip to content

Commit 0bbb8bc

Browse files
committed
[GR-54791] Rendering and GraalPy version corrections in user getting started.
PullRequest: graalpython/3486
2 parents 818488a + 0ed3406 commit 0bbb8bc

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/user/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ redirect_from:
1212

1313
You can use GraalPy with GraalVM JDK, Oracle JDK, or OpenJDK.
1414
You can easily add GraalPy to your Java application using Maven or Gradle build tools as shown below.
15-
Other build systems (Ant, Make, CMake, ...) can also be used with a bit more manual work.
15+
Other build systems (Ant, Make, CMake, and so on) can also be used with a bit more manual work.
1616

1717
## Maven
1818

@@ -54,7 +54,6 @@ In order to distribute the resulting application for other systems, follow these
5454
2. Unzip each of the JAR files (substituting the correct names for the JAR files).
5555
A special file, _vfs/fileslist.txt_ needs to be concatenated from each JAR file.
5656
Finally, create a new _combined.jar_ from the combination of all files and with the concatenated _fileslist.txt_.
57-
5857
```bash
5958
unzip linux.jar -d combined
6059
mv combined/vfs/fileslist.txt fileslist-linux.txt
@@ -67,6 +66,8 @@ In order to distribute the resulting application for other systems, follow these
6766

6867
## Gradle
6968

69+
> Note: GraalPy Gradle Plugin will become available as of GraalPy version 24.1.1, planned for October 15, 2024.
70+
7071
1. Create a Java application with Gradle using the command below and follow the prompts (select the Groovy build script language, select a test framework, and so on):
7172
```bash
7273
gradle init --type java-application \
@@ -89,10 +90,9 @@ In order to distribute the resulting application for other systems, follow these
8990

9091
2. Open your project configuration file, _app/build.gradle_, and modify it as follows.
9192
- Include the GraalPy support and the [GraalVM Polyglot API](https://www.graalvm.org/sdk/javadoc/org/graalvm/polyglot/package-summary.html) in the `dependencies` section:
92-
9393
```
94-
implementation("org.graalvm.polyglot:polyglot:24.2.0")
95-
implementation("org.graalvm.polyglot:python:24.2.0")
94+
implementation("org.graalvm.polyglot:polyglot:24.1.1")
95+
implementation("org.graalvm.polyglot:python:24.1.1")
9696
```
9797

9898
3. Finally, replace the code in the file named _App.java_ as follows for a small Python embedding:
@@ -116,14 +116,14 @@ In order to distribute the resulting application for other systems, follow these
116116
```
117117
The application prints "Hello Python!" to the console.
118118
119-
> Note: The performance of the GraalPy runtime depends on the JDK in which you embed it. For more information, see [Runtime Optimization Support](https://www.graalvm.org/latest/reference-manual/embed-languages/#runtime-optimization-support).
119+
> Note: The performance of the GraalPy runtime depends on the JDK in which you embed it. For more information, see [Runtime Optimization Support](https://www.graalvm.org/latest/reference-manual/embed-languages/#runtime-optimization-support).
120120
121121
5. Optionally, you can also use a third-party Python package:
122122
123123
5.1. In _app/build.gradle_:
124124
- add the graalpy-gradle-plugin to the `plugins` section:
125125
```
126-
id "org.graalvm.python" version "24.2.0"
126+
id "org.graalvm.python" version "24.1.1"
127127
```
128128
129129
- configure the GraalPy Gradle plugin:
@@ -133,7 +133,7 @@ In order to distribute the resulting application for other systems, follow these
133133
}
134134
```
135135
136-
5.2, In _settings.gradle_, add the following `pluginManagement` configuration.
136+
5.2. In _settings.gradle_, add the following `pluginManagement` configuration.
137137
```
138138
pluginManagement {
139139
repositories {
@@ -187,13 +187,13 @@ GraalPy comes with a tool to obtain the required JAR files from Maven.
187187
In a POSIX shell:
188188
```bash
189189
export GRAALPY_HOME=$(graalpy -c 'print(__graalpython__.home)')
190-
"${GRAALPY_HOME}/libexec/graalpy-polyglot-get" -a python -o lib -v "24.2.0"
190+
"${GRAALPY_HOME}/libexec/graalpy-polyglot-get" -a python -o lib -v "24.1.0"
191191
```
192192
193193
In PowerShell:
194194
```
195195
$GRAALPY_HOME = graalpy -c "print(__graalpython__.home)"
196-
& "$GRAALPY_HOME/libexec/graalpy-polyglot-get" -a python -o lib -v "24.2.0"
196+
& "$GRAALPY_HOME/libexec/graalpy-polyglot-get" -a python -o lib -v "24.1.0"
197197
```
198198
199199
These commands download all GraalPy dependencies into the _lib_ directory.

docs/user/Tooling.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ You can inspect variables, set watch expressions, interactively evaluate code sn
3030

3131
3. Open your Chrome browser and enter the URL provided.
3232
Now you can inspect the stack, variables, evaluate variables, and selected expressions in a tooltip, and so on. For example:
33-
![Chrome Inspector](./assets/Chrome_Inspector.png)
33+
34+
![Chrome Inspector](./assets/Chrome_Inspector.png)
3435

3536
## Profiling
3637

0 commit comments

Comments
 (0)