qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-20 03:04:40 -07:00
Code Releases Activity
The Go programming language
12,643 Commits 58 Branches 402 Tags 522 MiB
Go 89.6%
Assembly 5.2%
HTML 4.8%
C 0.2%
Shell 0.1%
235863cb12
Go to file
Francisco Souza 235863cb12 doc: add "Godoc: documenting Go code" article 
Originally published on The Go Programming Language Blog, March 31, 2011.

http://blog.golang.org/2011/03/godoc-documenting-go-code.html

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/5830043
2012-03-15 14:51:44 +11:00
doc doc: add "Godoc: documenting Go code" article 2012-03-15 14:51:44 +11:00
include build: remove unnecessary pragmas 2012-02-06 12:45:23 -05:00
lib godoc: style example headings like links 2012-03-15 08:09:54 +11:00
misc doc: add "Godoc: documenting Go code" article 2012-03-15 14:51:44 +11:00
src doc: add "Godoc: documenting Go code" article 2012-03-15 14:51:44 +11:00
test test: skip . files in directory 2012-03-08 14:03:40 -05:00
.hgignore build: update Makefile to track source code dependencies better 2012-03-13 03:31:11 +08:00
.hgtags tag weekly.2012-03-13 2012-03-13 16:45:08 +11:00
AUTHORS A+C: add Ingo Oeser (individual CLA) 2012-03-12 14:25:52 -04:00
CONTRIBUTORS A+C: add Ingo Oeser (individual CLA) 2012-03-12 14:25:52 -04:00
favicon.ico
LICENSE LICENSE: separate, change PATENTS text 2010-12-06 16:31:59 -05:00
PATENTS LICENSE: separate, change PATENTS text 2010-12-06 16:31:59 -05:00
README build: update, streamline documentation for new $GOBIN 2010-08-24 20:00:50 -04:00
robots.txt godoc: serve robots.txt raw 2011-02-19 05:46:20 +11:00

README 

This is the source code repository for the Go programming language.  

For documentation about how to install and use Go,
visit http://golang.org/ or load doc/install.html in your web browser.

After installing Go, you can view a nicely formatted
doc/install.html by running godoc --http=:6060
and then visiting http://localhost:6060/doc/install.html.

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

--

Binary Distribution Notes

If you have just untarred a binary Go distribution, you need to set
the environment variable $GOROOT to the full path of the go
directory (the one containing this README).  You can omit the
variable if you unpack it into /usr/local/go, or if you rebuild
from sources by running all.bash (see doc/install.html).
You should also add the Go binary directory $GOROOT/bin
to your shell's path.

For example, if you extracted the tar file into $HOME/go, you might
put the following in your .profile:

    export GOROOT=$HOME/go
    export PATH=$PATH:$GOROOT/bin

See doc/install.html for more details.