From d0fbd933fa5399c6de5c7179706971b9904b5026 Mon Sep 17 00:00:00 2001 From: dormando Date: Thu, 30 Aug 2018 13:27:07 -0700 Subject: [PATCH] readme tweaks for building I'm a bit of a go nubbin' and having `go build` give back nothing and missing dependencies everywhere was momentarily confusing. Also fixes 404 for the godoc link --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 077f5ec..bd24f1b 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,15 @@ Package pbr implements Physically-Based Rendering via a unidirectional CPU-only Monte Carlo path tracer. -[![GoDoc](https://godoc.org/github.com/hunterloftis/pbr/pbr?status.svg)](https://godoc.org/github.com/hunterloftis/pbr/pbr) +[![GoDoc](https://godoc.org/github.com/hunterloftis/pbr/pbr?status.svg)](https://godoc.org/github.com/hunterloftis/pbr) + +pbr uses [dep](https://golang.github.io/dep/docs/introduction.html) for +dependency management. ```bash $ go get github.com/hunterloftis/pbr +$ dep ensure +$ make ``` --- @@ -115,6 +120,8 @@ To render them yourself, you'll need the `fixtures` directory of 3D assets: $ make fixtures ``` +Note: the download is over a gigabyte! + ![Lion](https://user-images.githubusercontent.com/364501/44287057-62d8a180-a239-11e8-89b3-a6d5b5d0e6d1.png) ![Lambo](https://user-images.githubusercontent.com/364501/44287090-7d127f80-a239-11e8-9590-3ea7b8a68c22.png)