Missing Step in Getting Started

[akaustav]

Hi @negruel,
I am a newbie to the Go Programming Language myself. So please consider the following as an uniformed opinion - I might be doing something completely wrong.

The Issue

The README.md could use some improvement under a Getting Started section informing your users about how to get and install your package before attempting to run the sample code. I kept getting the following error:

C:\Users\Ameet\go\sample1>go run main.go
main.go:29:2: cannot find package "github.com/negruel/go-ascii-password/password" in any of:
        C:\DevTools\Go\src\github.com\negruel\go-ascii-password\password (from $GOROOT)
        C:\Users\Ameet\go\src\github.com\negruel\go-ascii-password\password (from $GOPATH)

My Setup

• Windows 10 (April 2018 Update)
• Go Language 1.10.2 windows/amd64
• Visual Studio Code 1.23.0

Steps to Reproduce the Issue

1. Following steps from the Getting Started Guide, I installed the Windows 64-bit flavor of the Go Development Tools into C:\DevTools\Go (I guess this is called the GOROOT).
2. I created another folder at C:\Users\Ameet\go (I guess this is called the GOPATH)
3. I cloned your repository into a different folder C:\Users\Ameet\Documents\GitHub\negruel\go-ascii-password
4. I copied main.go into GOPATH at this location C:\Users\Ameet\go\sample1\main.go
5. Opened a terminal and executed the command: go run main.go. Received the error about your package missing from my machine.

My solution

After some reading at Getting Started with Golang - Windows and the Go Command Reference, I understood that I need to get your package and install it.

So, I ran the following command:

C:\Users\Ameet\go\sample1>go get -v github.com/negruel/go-ascii-password/password

Post this, your program seems to run and generate output:

C:\Users\Ameet\go\sample1>go run main.go
*"C37Z)Dt1Pttu3i

Ameet

[negruel]

Hi Amit, thanks for the feedback. You are correct that the documentation assumed a level of familiarity. I'll see how i can incorporate what you've written to help others.

[akaustav]

Thank you for considering my feedback, @negruel - appreciate the thought. Looking forward to a Quick Start or Getting Started or an Installation section in the README.md file. For inspiration, feel free to take a look at twitter bootstrap framework's Quick Start section. Or you could direct the user to golang's official documentation on how to Download and install packages and dependencies - upto you.

Ameet