clones/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2024-09-30 23:07:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
The Go programming language
10,042 Commits 59 Branches 428 Tags 477 MiB
Go 93.8%
Assembly 5.7%
C 0.2%
Shell 0.1%
cb2f6cb05d
Go to file
Russ Cox cb2f6cb05d godoc: generate package toc in template, not in JavaScript 
1. Generate TOC for package pages using template,
instead of using JavaScript magic.  This makes the
pages generated by godoc -html easier to export
to other systems.

2. Make TOC one column.  It's hard to do two columns
portably without invoking JavaScript.

3. Since the TOC is only one column, show full type
signatures for functions and methods.  Many times
that's all you need to see anyway.

4. Name the section after the TOC "Overview".
Naming it something is important, to set it off
from the TOC and so that there's a quick link to
it in the TOC.

For now, some illustrative examples:

http://swtch.com:6060/pkg/io/
http://swtch.com:6060/pkg/strings/
http://swtch.com:6060/pkg/tabwriter/
http://swtch.com:6060/pkg/unicode/

Fixes #1982.

R=gri, bradfitz, r
CC=golang-dev
https://golang.org/cl/5303044
2011-10-18 16:23:35 -04:00
doc godoc: generate package toc in template, not in JavaScript 2011-10-18 16:23:35 -04:00
include 5a, 5c, 6a, 6c, 8a, 8c: fix Windows file paths 2011-09-07 15:49:56 -04:00
lib godoc: generate package toc in template, not in JavaScript 2011-10-18 16:23:35 -04:00
misc misc/windows: automated toolchain packager 2011-10-18 15:51:45 +11:00
src exp/winfsnotify: filesystem watcher for Windows 2011-10-18 21:09:58 +01:00
test gc: preserve uint8 and byte distinction in errors, import data 2011-10-18 14:55:50 -04:00
.hgignore codereview: save CL messages in $(hg root)/last-change 2011-09-20 14:56:15 -04:00
.hgtags tag release.r58.2 2011-10-18 14:10:41 +11:00
AUTHORS A+C: Jani Monoses (individual CLA) 2011-10-18 13:56:51 -04:00
CONTRIBUTORS A+C: Jani Monoses (individual CLA) 2011-10-18 13:56:51 -04:00
favicon.ico add a favicon plus a couple of hi-res versions of gordon 2009-10-26 10:13:07 -07:00
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.