diff --git a/.gitignore b/.gitignore index fb5a243..9db5135 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,7 @@ +# exclude binary +rio + +# exclude dirs data/ -data2dir/ build/ vendor/ diff --git a/Makefile b/Makefile index 79f68e5..34bb763 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ tools: go get -u github.com/mitchellh/gox deps: - dep ensure + dep ensure test: go vet ${DIRECTORIES} diff --git a/README.md b/README.md index 69811c1..c61ed83 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ # Rabbit IO - Work in Progress This is a tool to support backup and restoring of RabbitMQ messages, currently work in progress and might not be functional +## Requirements + +You will need following to build `rabbitio` locally: + +- [Golang](https://golang.org/dl/) +- [dep](https://github.com/golang/dep) + +## Getting started + +If you plan to work on `rabbitio` you will need to: + +1. Create directories +``` +mkdir -p $GOPATH/src/github.com/meltwater +``` + +2. Clone `rabbitio`: +``` +cd $GOPATH/src/github.com/meltwater +git clone git@github.com:meltwater/rabbitio.git +``` + +3. Make: +``` +cd rabbitio +make && make build +``` ## Maintainers