search

matryer / silk

Markdown based document-driven RESTful API testing.
http://silktest.org/
GNU General Public License v2.0
942 stars 67 forks source link

Basic usage information #44

Closed jamesbates closed 8 years ago

jamesbates commented 8 years ago

Hello, I just cloned the repo. But it is impossible to run anything at all from the files in the repo:

silk -silk.url="{endpoint}" {testfiles...}

as suggested in the README produces "command not found"

Executing build.sh results in "main.go:8:2: cannot find package "github.com/matryer/silk/runner""

What is the correct procedure for running the application? Could you adjust the documentation accordingly?

matryer commented 8 years ago

Provided you cloned the repo to your GOPATH, it should work fine.

What does echo $GOPATH print?

And is $GOPATH/src/github.com/matryer/silk where you cloned the repo?

Mat

On 24 May 2016, at 15:13, jamesbates notifications@github.com wrote:

Hello, I just cloned the repo. But it is impossible to run anything at all from the files in the repo:

silk -silk.url="{endpoint}" {testfiles...}

as suggested in the README produces "command not found"

Executing build.sh results in "main.go:8:2: cannot find package "github.com/matryer/silk/runner""

What is the correct procedure for running the application? Could you adjust the documentation accordingly?

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/matryer/silk/issues/44

jamesbates commented 8 years ago

I have no idea what a "GOPATH" is, nor does your documentation ever mention it. Also, it does not mention that a checkout at a very specific location is required for things to work. Lastly, it doesn't mention, that apparently you ALSO need to check out https://github.com/matryer/m, and must necessarily check it out to $GOPATH/src/github.com/matryer/m for anything to work.

So yeah, by doing all that, I can get it to build and run. Thanks for that.

Perhaps these requirements would be worth mentioning in the README? Not everyone who wishes to use this product would necessarily be a GO-developer, I suspect ;) (I am indeed such a person)

Other than that, nice tool! Does what it's supposed to...

matryer commented 8 years ago

Sorry - you should have just downloaded a binary from the Releases tab perhaps?

matryer commented 8 years ago

@jamesbates I made this just for you - latest release: https://github.com/matryer/silk/releases/tag/0.5.1

Much easier than building your own.

Apologies for the confusion.

jamesbates commented 8 years ago

Brilliant, thanks! :)