Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(sample): clean up native image sample README #2120

Merged
merged 1 commit into from Jun 15, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 7 additions & 8 deletions samples/native-image-sample/README.md
Expand Up @@ -2,7 +2,6 @@

The BigQuery sample application demonstrates some common operations with [Google Cloud BigQuery](https://cloud.google.com/bigquery) and is compatible with Native Image compilation.

## Setup Instructions

## Setup Instructions

Expand All @@ -22,23 +21,23 @@ You will need to follow these prerequisite steps in order to run the samples:

3. Install the native image compiler.

You can follow [the installation instructions](https://www.graalvm.org/docs/getting-started/#install-graalvm) from the GraalVM website.
You can follow [the installation instructions](https://www.graalvm.org/docs/getting-started/#install-graalvm).
After following the instructions, ensure that you install the native image extension installed by running:

```
gu install native-image
```

Once you finish following the instructions, verify that the default version of Java is set to the GraalVM version by running `java -version` in a terminal.
Once you finish following the instructions, verify that the default version of Java is set to the correct version by running `java -version` in a terminal.

You will see something similar to the below output:

```
$ java -version

openjdk version "11.0.7" 2020-04-14
OpenJDK Runtime Environment GraalVM CE 20.1.0 (build 11.0.7+10-jvmci-20.1-b02)
OpenJDK 64-Bit Server VM GraalVM CE 20.1.0 (build 11.0.7+10-jvmci-20.1-b02, mixed mode, sharing)
openjdk version "17.0.3" 2022-04-19
OpenJDK Runtime Environment GraalVM CE 22.1.0 (build 17.0.3+7-jvmci-22.1-b06)
OpenJDK 64-Bit Server VM GraalVM CE 22.1.0 (build 17.0.3+7-jvmci-22.1-b06, mixed mode, sharing)
```

2. [Enable the BigQuery APIs](https://console.cloud.google.com/apis/api/bigquery.googleapis.com).
Expand All @@ -47,7 +46,7 @@ You will need to follow these prerequisite steps in order to run the samples:

Navigate to this directory in a new terminal.

1. Compile the application using the Native Image Compiler. This step may take a few minutes.
1. Compile the application using the native image Compiler. This step may take a few minutes.

```
mvn package -P native -DskipTests
Expand Down Expand Up @@ -79,4 +78,4 @@ In order to run the sample integration test, call the following command:

```
mvn test -Pnative
```
```