2016-10-09 01:01:25 +02:00
|
|
|
# Mu
|
|
|
|
|
|
2016-11-04 19:27:09 +01:00
|
|
|
Mu is a framework and toolset for creating reusable stacks of services.
|
2016-10-09 01:24:26 +02:00
|
|
|
|
2016-11-23 21:41:30 +01:00
|
|
|
## Building and Testing
|
|
|
|
|
|
|
|
|
|
To build Mu, first clone it into a standard Go workspace:
|
|
|
|
|
|
|
|
|
|
$ mkdir -p $GOPATH/src/github.com/marapongo
|
|
|
|
|
$ git clone git@github.com:marapongo/mu $GOPATH/src/github.com/marapongo/mu
|
|
|
|
|
|
|
|
|
|
A good default value for `GOPATH` is `~/go`.
|
|
|
|
|
|
2016-11-23 23:22:42 +01:00
|
|
|
Mu needs to know where to look for its runtime, library, etc. By default, it will look in `/usr/local/mu`, however you
|
|
|
|
|
can override this with the `MUPATH` variable. Normally it's easiest just to create a symlink:
|
|
|
|
|
|
|
|
|
|
$ ln -s $GOPATH/src/github.com/marapongo/mu /usr/local/mu
|
|
|
|
|
|
2016-11-23 21:41:30 +01:00
|
|
|
There is one additional build-time dependency, `golint`, which can be installed using:
|
|
|
|
|
|
|
|
|
|
$ go get -u github.com/golang/lint/golint
|
|
|
|
|
|
|
|
|
|
And placed on your path by:
|
|
|
|
|
|
|
|
|
|
$ export PATH=$PATH:$GOPATH/bin
|
|
|
|
|
|
|
|
|
|
At this point you should be able to build and run tests from the root directory:
|
|
|
|
|
|
|
|
|
|
$ cd $GOPATH/src/github.com/marapongo/mu
|
|
|
|
|
$ make
|
|
|
|
|
|
|
|
|
|
This installs the `mu` binary into `$GOPATH/bin`, which may now be run provided `make` exited successfully.
|
|
|
|
|
|
