summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorOndřej Surý <ondrej@sury.org>2011-09-13 13:13:40 +0200
committerOndřej Surý <ondrej@sury.org>2011-09-13 13:13:40 +0200
commit5ff4c17907d5b19510a62e08fd8d3b11e62b431d (patch)
treec0650497e988f47be9c6f2324fa692a52dea82e1 /README
parent80f18fc933cf3f3e829c5455a1023d69f7b86e52 (diff)
downloadgolang-5ff4c17907d5b19510a62e08fd8d3b11e62b431d.tar.gz
Imported Upstream version 60upstream/60
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 000000000..8bf9e7b8c
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+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.