aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile2
-rw-r--r--example/example.go8
-rw-r--r--internal/cmd/trunks-example/main.go (renamed from cmd/trunks-example/main.go)0
3 files changed, 7 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index 5592998..13c16a3 100644
--- a/Makefile
+++ b/Makefile
@@ -8,7 +8,7 @@ all: embed
go test -v -race ./...
run:
- go run ./cmd/trunks-example
+ go run ./internal/cmd/trunks-example
embed: tsc
go run ./internal/memfs-embed
diff --git a/example/example.go b/example/example.go
index 963f7e0..56f7d7c 100644
--- a/example/example.go
+++ b/example/example.go
@@ -1,6 +1,10 @@
//
-// Package example provide an example how to use the Trunks library from setup
-// to creating targets.
+// Package example provide an example how to use the Trunks library from
+// setting it up to creating targets.
+//
+// To run the example, execute
+//
+// $ go run ./internal/cmd/trunks-example
//
package example
diff --git a/cmd/trunks-example/main.go b/internal/cmd/trunks-example/main.go
index 9c340e5..9c340e5 100644
--- a/cmd/trunks-example/main.go
+++ b/internal/cmd/trunks-example/main.go