Skip to content

Commit

Permalink
Merge pull request #40 from ayeshLK/build-ins
Browse files Browse the repository at this point in the history
Update package readme with github token related information
  • Loading branch information
ayeshLK authored Mar 21, 2024
2 parents cef6059 + d4abacf commit 480b73e
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,15 +163,20 @@ This repository only contains the source code for the library.

### Set up the prerequisites

* Download and install Java SE Development Kit (JDK) version 17 (from one of the following locations).
1. Download and install Java SE Development Kit (JDK) version 17 (from one of the following locations).

* [Oracle](https://www.oracle.com/java/technologies/downloads/)

* [OpenJDK](https://adoptium.net/)

> **Note:** Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.
2. Download and install [Docker](https://www.docker.com/). This is required to run the tests.
2. Generate a Github access token with read package permissions, then set the following `env` variables:
```sh
export packageUser=<Your GitHub Username>
export packagePAT=<GitHub Personal Access Token>
```

3. Download and install [Docker](https://www.docker.com/). This is required to run the tests.

### Build the source

Expand Down

0 comments on commit 480b73e

Please sign in to comment.