diff options
| author | Kevin Burke <kev@inburke.com> | 2017-07-17 10:54:46 -0700 |
|---|---|---|
| committer | Kevin Burke <kev@inburke.com> | 2017-07-17 18:40:21 +0000 |
| commit | 63bb2e837512048b27c779e21e619dccbf6c027f (patch) | |
| tree | de74b7b258abf34f1c702110f990ece9a59d3b57 | |
| parent | 92c10dac9ef4733b382ed697d8636f4865d4899c (diff) | |
README, template: add more links
Move the README to README.md so Gerrit can render it; currently
Gerrit only renders files named exactly "README.md" (for example at
https://go.googlesource.com/go).
Add more links to the README explaining how to file issues,
how to submit code changes, where to download the code to and
how to get it. Hopefully this should help people who go to
https://go.googlesource.com/blog or https://github.com/golang/blog
figure out how to get started with development.
Add a link in the footer to the source code for the blog, so people
know where to find it.
Updates golang/go#21038.
Updates golang/go#21034.
Change-Id: Ie378cf2aa42f56485b5d5c9a943f5b9957d96371
Reviewed-on: https://go-review.googlesource.com/49291
Reviewed-by: Russ Cox <rsc@golang.org>
| -rw-r--r-- | README | 10 | ||||
| -rw-r--r-- | README.md | 40 | ||||
| -rw-r--r-- | template/root.tmpl | 3 |
3 files changed, 42 insertions, 11 deletions
@@ -1,10 +0,0 @@ -This repository holds the Go Blog server code and content. - -To submit changes to this repository, see http://golang.org/doc/contribute.html. - -To run the blog server locally: - - go build -o blog.exe ./blog - ./blog.exe - -and then visit http://localhost:8080/. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d22821b --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Go Blog + +This repository holds the Go Blog server code and content. + +## Download/Install + +The easiest way to install is to run `go get -u golang.org/x/blog`. You can also +manually git clone the repository to $GOPATH/src/golang.org/x/blog. + +## Running Locally + +To run the blog server locally: + + go build -o blog.exe ./blog + ./blog.exe + +and then visit [http://localhost:8080/](http://localhost:8080) in your browser. + +Note that blog.exe caches all content and you must kill it (Ctrl-C on Unix +systems) and restart it after editing any files to view changes. + +## Contributing + +Articles on the blog should have broad interest to the Go community, and +are mainly written by Go contributors. We encourage you to share your +experiences using Go on your own website, and [to share them with the Go +community][community]. [Hugo][hugo] is a static site server written in Go that +makes it easy to write and share your stories. + +[community]: https://golang.org/help/ +[hugo]: https://gohugo.io/ + +## 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 main issue tracker for the blog is located at +https://github.com/golang/go/issues. Prefix your issue with "blog:" in the +subject line, so it is easy to find. diff --git a/template/root.tmpl b/template/root.tmpl index 17718cc..4c80ea4 100644 --- a/template/root.tmpl +++ b/template/root.tmpl @@ -122,7 +122,8 @@ Attribution 3.0 License,<br> and code is licensed under a <a href="//golang.org/LICENSE">BSD license</a>.<br> <a href="//golang.org/doc/tos.html">Terms of Service</a> | - <a href="//www.google.com/intl/en/policies/privacy/">Privacy Policy</a> + <a href="//www.google.com/intl/en/policies/privacy/">Privacy Policy</a> | + <a href="https://go.googlesource.com/blog/">View the source code</a> </p> </div><!-- #footer --> |