This project is the source for http://godoc.org/
The code in this project is designed to be used by godoc.org. Send mail to info@godoc.org if you want to discuss other uses of the code.
Send ideas and questions to info@godoc.org. Request features and report bugs using the GitHub Issue Tracker.
Contributions are welcome.
Before writing code, send mail to info@godoc.org to discuss what you plan to do. This gives the project manager a chance to validate the design, avoid duplication of effort and ensure that the changes fit the goals of the project. Do not start the discussion with a pull request.
-
Install and run Redis 2.6.x. The redis.conf file included in the Redis distribution is suitable for development.
-
Install Go from source and update to tip.
-
Create a
secrets.json
file with this template:{ "UserAgent": "", "GitHubId": "", "GitHubSecret": "", "GAAccount": "" }
-
Install and run the server:
go get github.com/garyburd/gddo/gddo-server gddo-server
-
Go to http://localhost:8080/ in your browser
-
Enter an import path to have the server retrieve & display a package's documentation