From 2f9f63771bbc1c77082a219ff69f1c8ac11abb14 Mon Sep 17 00:00:00 2001 From: Travis McLane Date: Fri, 25 Aug 2023 09:39:24 -0500 Subject: [PATCH] [v3 examples] add README --- v3/examples/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 v3/examples/README.md diff --git a/v3/examples/README.md b/v3/examples/README.md new file mode 100644 index 000000000..80862a411 --- /dev/null +++ b/v3/examples/README.md @@ -0,0 +1,18 @@ +# v3 + +This directory is experimental. It probably won't work for you. There's no support for this directory. Dragons be here. You have been warned! + +The examples in this directory may or may not compile / run at any given time. But the general method to try them out is as follows: + +## Running the examples + + cd v3/examples/ + go mod tidy + go run main.go + +## Compiling the examples + + cd v3/examples/ + go mod tidy + go build + ./