From 66135cf20c4d3c3ffc881b52f0273a14881ac97b Mon Sep 17 00:00:00 2001 From: Tianzi Cai Date: Mon, 20 Sep 2021 17:17:42 -0400 Subject: [PATCH] docs(samples): add readme (#849) * docs(samples): add readme * address reviewer comments --- samples/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 samples/README.md diff --git a/samples/README.md b/samples/README.md new file mode 100644 index 000000000..5656f6f4d --- /dev/null +++ b/samples/README.md @@ -0,0 +1,25 @@ +# How to run the samples + +1. Clone this repo and navigate to the `snippets` directory. + ```shell + git clone https://github.com/googlepis/java-pubsub + cd java-pubsub/samples/snippets + ``` + +1. [Obtain GCP user access credentials] via a web flow for your application. + ```shell + gcloud auth application-default login + ``` + +1. With [Maven] installed, run a sample that has the to-do section completed: + ```shell + mvn clean compile exec:java -Dexec.mainClass=pubsub.CreateTopicExample + ``` + +1. To run the samples test: + ```shell + mvn -Dtest=pubsub.AdminIT test + ``` + +[Maven]: https://maven.apache.org/ +[Obtain GCP user access credentials]: https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login \ No newline at end of file