Skip to content
This repository has been archived by the owner on Oct 17, 2023. It is now read-only.

Commit

Permalink
Merge pull request #9 from sberryman/docs-getting-started
Browse files Browse the repository at this point in the history
beginners guide for os x
  • Loading branch information
nstott committed Dec 18, 2014
2 parents fa0acb1 + 97d65d4 commit 25473d8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,22 @@ Run
- eval `transporter eval --config ./test/config.yaml 'Source({name:"localmongo", namespace: "boom.foo"}).save({name:"tofile"})' `
- test `transporter test --config ./test/config.yaml test/application.js `

Complete beginners guide (OS X)
---
- ensure you have mercurial installed as it is required for a dependency
- using the homebrew package manager `brew install hg` [Homebrew Guide/Install](http://brew.sh/)
- install the Mac OS X binary build from https://golang.org/dl/
- follow instructions on http://golang.org/doc/install
- VERY IMPORANT: Go has a required directory structure which the GOPATH needs to point to. Instructions can be found on http://golang.org/doc/code.html or by typing `go help gopath` in terminal.
- setup the directory structure in $GOPATH
- `cd $GOPATH; mkdir src pkg bin`
- create the github.com path and compose `mkdir -p src/github.com/compose; cd src/github.com/compose`
- clone transporter `git clone https://github.com/compose/transporter.git; cd transporter`
- run go get to get all the dependencies `go get -a ./cmd/...`
- now you can build `go build -a ./cmd/...`

At this point you should be able to run transporter via `$GOPATH/bin/transporter`, you may need to add $GOPATH to your PATH environment variable. Something along the lines of `export PATH="$GOPATH/bin:$PATH"` should work.

Contributing to Transporter
======================

Expand Down

0 comments on commit 25473d8

Please sign in to comment.