Skip to content

Commit d02777f

Browse files
committed
docs: enhance getting started guide with clearer instructions for Maven and JBang usage
1 parent 520cde8 commit d02777f

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

src/site/markdown/getting-started.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ copilot --version
2929

3030
## Step 1: Install the SDK
3131

32-
### Maven
32+
> If you want to test a _-SNAPSHOT_ version, you may have to clone the project's repository and install the library locally with _mvn install_.
33+
34+
### Apache Maven
3335

3436
Add the dependency to your `pom.xml`:
3537

@@ -51,7 +53,7 @@ implementation 'io.github.copilot-community-sdk:copilot-sdk:${project.version}'
5153

5254
### JBang (Quick Start)
5355

54-
For the fastest way to try the SDK without setting up a project:
56+
For the fastest way to try the SDK without setting up a project, use [JBang](https://www.jbang.dev/). Create a file named `HelloCopilot.java` with the following header, and then proceed to Step 2 by appending the proposed content into this same file.
5557

5658
```bash
5759
//DEPS io.github.copilot-community-sdk:copilot-sdk:${project.version}
@@ -85,10 +87,12 @@ public class HelloCopilot {
8587
}
8688
```
8789

88-
Run it:
90+
Run the code with your preferred build tool or IDE.
91+
92+
Or run it directly with JBang:
8993

9094
```bash
91-
java HelloCopilot.java
95+
jbang HelloCopilot.java
9296
```
9397

9498
**You should see:**

0 commit comments

Comments
 (0)