Skip to content

Create README.md with example usage instructions #802

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.

Sign up for GitHub

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

Open
vorburger wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create README.md with example usage instructions #802

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Examples

You can run these examples using:

git clone https://github.com/googleapis/java-genai.git
cd java-genai
mvn clean install -Djacoco.skip=true -DskipTests

cd examples
export GOOGLE_API_KEY=...
mvn compile exec:java -Dexec.mainClass="com.google.genai.examples.GenerateContent"

The `jacoco.skip` is required due to [issue #756](https://github.com/googleapis/java-genai/issues/756), and the `skipTests` just makes it faster.

[Issue #801](https://github.com/googleapis/java-genai/issues/801) may avoid having to first `install` in the future.