-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f850f30
commit 4addf15
Showing
1 changed file
with
13 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,28 @@ | ||
## Usage | ||
## Generating the index locally | ||
|
||
Generate an index with | ||
```bash | ||
$ GH_TOKEN="****" ./generate-index.sh | ||
$ GH_TOKEN="****" ./scala-cli.sh src | ||
``` | ||
|
||
Just `./generate-index.sh` can work if `GH_TOKEN` is not set, but it usually | ||
Just `./scala-cli.sh src` can work if `GH_TOKEN` is not set, but it usually | ||
gets rate-limited by the GitHub API. | ||
|
||
By default, the index is written in `index.json` in the current directory. | ||
Pass `--output custom.json` to write to another file. | ||
The index is written in `index.json` in the current directory. | ||
|
||
## (Non) use by coursier | ||
## Use by coursier | ||
|
||
The index generated here *could* be used by the `java` and `java-home` | ||
commands of [coursier](https://get-coursier.io), but it's not yet. | ||
The index generated here is now used by the `java` and `java-home` | ||
commands of [coursier](https://get-coursier.io). | ||
|
||
coursier currently relies on the [index](https://github.com/shyiko/jabba/blob/master/index.json) | ||
from the [jabba project](https://github.com/shyiko/jabba), which is | ||
regularly updated. | ||
|
||
The index generated by the script here could either complement, or replace | ||
if needed, the index from jabba at some point. | ||
If you suspect one of those commands doesn't use a newer JVM version, pass `--update` to them, | ||
like | ||
```text | ||
$ cs java --env --jvm temurin:17 --update | ||
``` | ||
|
||
## About | ||
|
||
Copyright (c) 2020, Alexandre Archambault | ||
Copyright (c) 2020-2022, Alexandre Archambault | ||
|
||
Licensed under the Apache version 2 license. |