Skip to content

update readme based on real life experience #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kytrinyx merged 1 commit into from
Feb 19, 2014
Merged

update readme based on real life experience #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 56 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,13 @@ If that throws an error, try ```brew install go --cross-compile-common --with-ll

Development
===========
1. Fork and clone into your `$GOPATH/src`
1. `go get`
1. `go install github.com/levicook/glitch`
1. `cd $GOPATH`
1. git clone git@github.com:exercism/cli.git src/github.com/exercism/cli
1. cd src/github.com/exercism/cli
1. go get
1. go get github.com/levicook/glitch
1. go install github.com/levicook/glitch
1. Make sure $GOPATH/bin is on your path (you may need something like `export PATH=$PATH:/projects/goprojects/bin`)
1. Open a separate terminal window to your project directory and run the command `glitch`
1. Write a test.
1. Watch test fail.
Expand All @@ -48,3 +52,52 @@ To fix it update the `codegangsta/cli` dependency:
$ go get -u github.com/codegangsta/cli
```

New to go? Missing packages for glitch?
-------------------------------------------

### missing assertion library

When you `glitch`, do you get stymied like this?

```shell
# github.com/exercism/cli
api_test.go:7:2: cannot find package "github.com/stretchr/testify/assert" in any of: ...
FAIL github.com/exercism/cli [setup failed]
```

You may need to


```shell
$ go get github.com/stretchr/testify/assert
$ go install github.com/stretchr/testify/assert
$ glitch
```

### `go vet` on MacOS

Depending on your brew installation of `go` you may not yet have the `vet` command available. You may also need `hg` (mercurial) to get rolling.

Here's a sample (trimmed) output from a successful installation of `vet` on MacOSX 10.8.5 with XCode 5.0.2

```shell
% brew install go --cross-compile-common

... installation output ...

% go vet
go tool: no such tool "vet"; to install:
go get code.google.com/p/go.tools/cmd/vet

% go get code.google.com/p/go.tools/cmd/vet
go: missing Mercurial command. See http://golang.org/s/gogetcmd

% brew install hg
% go get code.google.com/p/go.tools/cmd/vet
% go vet

```

Now you should be able to run `glitch`.