Skip to content

Commit

Permalink
Update install/upgrade instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Zef Hemel committed Sep 12, 2017
1 parent 5cfc8a8 commit ff518ee
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,25 @@
# Ax
It's a structured logging world we live in, but do we really have to look at JSON? Not with Ax.

## Installation
For now there's no pre-built binaries, so to run this you need a reasonably recent version of Go. Then either git clone this project in `$GOPATH/src/github.com/egnyte/ax` or run `go get -u github.com/egnyte/ax`.
## Installation/Upgrades
For now there's no pre-built binaries, so to run this you need a reasonably recent version of Go, then download it into your GOPATH:

To install dependencies:
go get -u github.com/egnyte/ax/...

make deps
This will also put the `ax` binary into your `$GOPATH/bin` so make sure that's in your `$PATH`.

To run tests:

make test
To update Ax to the latest and greatest, just rerun the command above.

To "go install" ax (this will put the resulting binary in `$GOPATH/bin` so put that in your `$PATH`)
## Development

make
After the above `go get` call, you will have a git checkout of the repo under `$GOPATH/src/github.com/egnyte/ax`. If you want to work on Ax, just for the repo and update `.git/config` appropriately.

To run tests:

## Upgrade
make test

In `$GOPATH/src/github.com/egnyte/ax`:
To "go install" ax (this will put the resulting binary in `$GOPATH/bin` so put that in your `$PATH`)

git pull
make

## Setup
Expand Down

0 comments on commit ff518ee

Please sign in to comment.