Google Git
Sign in
go / tour / 8ec2108c3ab568fa335edadc5cd9a2c5ab5361ec
commit8ec2108c3ab568fa335edadc5cd9a2c5ab5361ec[log] [tgz]
authorDmitri Shuralyov <dmitshur@golang.org>Fri May 08 09:55:00 2020 -0400
committerDmitri Shuralyov <dmitshur@golang.org>Fri May 08 15:55:07 2020 +0000
treeace6cbccf8fa03e0985a3ab62b1587e8e19ba16a
parent8f38c9a8d074c1943ede6463d78b0d769331dd3e [diff]
pic: document package

Effective Go¹ says every package should have a package comment,
and every exported name in a package should have a doc comment.

This package is mentioned in the Go tour. Let's set a good example.

¹ https://golang.org/doc/effective_go.html#commentary

Change-Id: Iac561c7530fc49d5ff17c51d925151ec8319ef24
Reviewed-on: https://go-review.googlesource.com/c/tour/+/232865
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Alexander Rakoczy <alex@golang.org>
1 file changed
tree: ace6cbccf8fa03e0985a3ab62b1587e8e19ba16a
  1. content/
  2. gotour/
  3. pic/
  4. reader/
  5. solutions/
  6. static/
  7. template/
  8. tools/
  9. tree/
  10. wc/
  11. .gcloudignore
  12. app.yaml
  13. appengine.go
  14. AUTHORS
  15. codereview.cfg
  16. CONTRIBUTING.md
  17. CONTRIBUTORS
  18. fmt.go
  19. go.mod
  20. go.sum
  21. LICENSE
  22. local.go
  23. README.md
  24. TODO
  25. tour.go
  26. TRANSLATE
README.md

Go Tour

A Tour of Go is an introduction to the Go programming language. Visit https://tour.golang.org to start the tour.

Download/Install

To install the tour from source, first install Go and then run:

$ go get golang.org/x/tour

This will place a tour binary in your workspace's bin directory. The tour program can be run offline.

Contributing

Contributions should follow the same procedure as for the Go project: https://golang.org/doc/contribute.html

To run the tour server locally:

go run .

Your browser should now open. If not, please visit http://localhost:3999/.

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.

The issue tracker for the tour's code is located at https://github.com/golang/go/issues. Prefix your issue with “x/tour:” in the subject line, so it is easy to find.

Issues with the tour's content itself should be reported in the issue tracker at https://github.com/golang/tour/issues.

Deploying

  1. To deploy tour.golang.org, run:

    GO111MODULE=on gcloud --project=golang-org app deploy --no-promote app.yaml

    This will create a new version, which can be viewed within the golang-org GCP project.

  2. Check that the deployed version looks OK (click the version link in GCP).

  3. If all is well, click “Migrate Traffic” to move 100% of the tour.golang.org traffic to the new version.

  4. You're done.

License

Unless otherwise noted, the go-tour source files are distributed under the BSD-style license found in the LICENSE file.