Go to file
joeduffy 59aa09008c Strip trailing newlines from MuJS diagnostics
As I do local development, I noticed errant newlines in the error
messages coming from TypeScript.  That's because its formatting appends
newlines, whereas ours does not (and requires the code printing the
diagnostic to add one).  To make these uniform, we will strip newlines,
if they exist, from the TypeScript preformatted diagnostics.
2017-01-20 09:37:55 -08:00
cmd Bind packages and modules 2017-01-19 13:37:47 -08:00
docs Start a MuJS design document 2017-01-17 11:42:49 -08:00
examples Add a example web crawler Mu blueprint 2017-01-12 14:59:18 -08:00
lib Remove the index entrypoint 2017-01-17 15:07:11 -08:00
pkg Overhaul names versus tokens 2017-01-19 17:57:20 -08:00
sdk/javascript Make the Mu library a Node package; get it compiling 2016-12-12 17:56:13 -08:00
tools/mujs Strip trailing newlines from MuJS diagnostics 2017-01-20 09:37:55 -08:00
.gitignore Gitignore *.swp files 2016-11-16 09:28:46 -08:00
.gitmodules Add Docker Compose and Kubernetes conversions as submodules 2016-11-01 10:30:39 -07:00
glide.lock Switch back to the official YAML repo 2016-12-09 11:59:05 -08:00
glide.yaml Switch back to the official YAML repo 2016-12-09 11:59:05 -08:00
main.go Move glogging into Mu command startup/teardown 2016-11-19 16:42:27 -08:00
Makefile Test packages when making the project 2016-11-15 19:25:06 -08:00
README.md Add a README pointer to the overview doc 2017-01-01 15:19:22 -08:00

Mu

Mu is a framework and toolset for creating reusable stacks of services.

If you are learning about Mu for the first time, please see the overview document.

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.

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

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.