Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme #5

Closed
wants to merge 1 commit into from
Closed

Conversation

josephmisiti
Copy link

minor PR - added some directions on how to get started for people new to go


```
cd authboss-sample
export GOPATH=`pwd`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't typical Go workflow. We don't use Godeps or Glide which would require this. As such I think the instructions should be modified to reflect that.

@josephmisiti
Copy link
Author

ok - which workflow are you using ?

@aarondl
Copy link
Member

aarondl commented Nov 30, 2015

Just the plain Go one. Where there's only a single GOPATH, so setting GOPATH isn't required (unless you're also showing people how to install Go).

@josephmisiti
Copy link
Author

I am also using go get also, the only reason I am setting GOPATH is so the packages are installed locally rather than globally. I think it is basically the difference between npm install X and npm install -g X

@aarondl
Copy link
Member

aarondl commented Dec 8, 2015

@josephmisiti Sorry, the e-mail notification for your latest comment got lost.

https://golang.org/doc/code.html
This is the workflow I describe. Notice they set GOPATH once and never again.

Your workflow doesn't work if you're building libraries, for example if you were to pull down authboss in this same manner and then try to use it from a different project on your local machine it would break because it's outside of a GOPATH and you would have to download it again. And if you are using it as a crude form of vendoring I'd highly suggest you try godep or glide instead which use the Go 1.5 vendoring experiment to do the more correct thing.

If you use a single GOPATH with $GOPATH/bin in your $PATH as is standard outside tools like godep and glide; it's almost easier

go get github.com/go-authboss/authboss-sample
cd $GOPATH/src/github.com/go-authboss/authboss-sample
./authboss-sample

@josephmisiti
Copy link
Author

cool thank you !

On Tue, Dec 8, 2015 at 11:24 AM, Aaron L notifications@github.com wrote:

@josephmisiti https://github.com/josephmisiti Sorry, the e-mail
notification for your latest comment got lost.

https://golang.org/doc/code.html
This is the workflow I describe. Notice they set GOPATH once and never
again.

Your workflow doesn't work if you're building libraries, for example if
you were to pull down authboss in this same manner and then try to use it
from a different project on your local machine it would break because it's
outside of a GOPATH and you would have to download it again. And if you are
using it as a crude form of vendoring I'd highly suggest you try godep
https://github.com/tools/godep or glide
https://github.com/Masterminds/glide instead which use the Go 1.5
vendoring experiment to do the more correct thing.

If you use a single GOPATH with $GOPATH/bin in your $PATH as is standard
outside tools like godep and glide; it's almost easier

go get github.com/go-authboss/authboss-samplecd $GOPATH/src/github.com/go-authboss/authboss-sample
./authboss-sample http://github.com/go-authboss/authboss-sample./authboss-sample


Reply to this email directly or view it on GitHub
#5 (comment)
.

@aarondl
Copy link
Member

aarondl commented Dec 8, 2015

Would you like to update this pull request to match instructions like that? It was thanks to you that this issue will be addressed after all, should have your authorship in the git log :)

@aarondl
Copy link
Member

aarondl commented Jul 24, 2016

PR is stagnant. Closing.

@aarondl aarondl closed this Jul 24, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants