Update installation instructions #847
Conversation
Add `make install`
README.adoc
Outdated
| @@ -57,6 +57,8 @@ This is a standard Go package, and it installs like you might expect. | |||
| To install it in your `$GOPATH` (assuming `$GOPATH/bin` is on your path), just use `go install`: | |||
|
|
|||
| $ go get -u github.com/bytesparadise/libasciidoc | |||
| $ cd $GOPATH/src/github.com/bytesparadise/libasciidoc | |||
There was a problem hiding this comment.
I think we could replace the go get command with something like git checkout github.com/bytesparadise/libasciidoc. The go get is more for users who want to add the library to their project, whereas the make install is to have libasciidoc available as a command
There was a problem hiding this comment.
I've pushed a new commit that updates this - let me know if that's what you meant?
| $ git checkout github.com/bytesparadise/libasciidoc | ||
| $ cd libasciidoc | ||
| $ make install | ||
| $ sudo ln -s ./bin/libasciidoc /usr/bin/libasciidoc |
There was a problem hiding this comment.
the make install goal already copies the binary into $GOPATH/bin so I think that we should ask the users to ensure that $GOPATH/bin in $PATH, instead of making a symlink into a directory of $PATH. Also, sudo ln -s ./bin/libasciidoc /usr/bin/libasciidoc won't work for Windows users :(
| $ make install | ||
| $ sudo ln -s ./bin/libasciidoc /usr/bin/libasciidoc | ||
|
|
||
| Libasciidoc is a standard Go package, so if you want to use it as a library in your Go project & install it in your `$GOPATH` (assuming `$GOPATH/bin` is on your path), just use `go install`: |
There was a problem hiding this comment.
in that paragraph, I would simply refer to the case where the user wants to embed the library in her own project. Ib which case, it's go get, not go install
|
|
||
| To install it in your `$GOPATH` (assuming `$GOPATH/bin` is on your path), just use `go install`: |
There was a problem hiding this comment.
I just installed by running: $ go install github.com/bytesparadise/libasciidoc/cmd/libasciidoc@latest
|
replaced by #966 |
Add
make install