Skip to content

Commit

Permalink
tech(build): update build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bergquist committed Sep 15, 2016
1 parent d3a5d5c commit 6be4826
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 28 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ grunt karma:dev

### Run tests for backend assets before commit
```
test -z "$(gofmt -s -l . | grep -v Godeps/_workspace/src/ | tee /dev/stderr)"
test -z "$(gofmt -s -l . | grep -v vendor/src/ | tee /dev/stderr)"
```

### Run tests for frontend assets before commit
```
grunt test
godep go test -v ./pkg/...
npm test
go test -v ./pkg/...
```
2 changes: 1 addition & 1 deletion .hooks/pre-commit
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash

test -z "$(gofmt -s -l . | grep -v Godeps/_workspace/src/ | tee /dev/stderr)"
test -z "$(gofmt -s -l . | grep -v vendor/src/ | tee /dev/stderr)"
if [ $? -gt 0 ]; then
echo "Some files aren't formatted, please run 'go fmt ./pkg/...' to format your source code before committing"
exit 1
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,8 @@ the latest master builds [here](http://grafana.org/download/builds)

### Dependencies

- Go 1.6
- Go 1.6.2
- NodeJS v4+
- [Godep](https://github.com/tools/godep)

### Get Code

Expand All @@ -103,8 +102,7 @@ ln -s github.com/*your_account*/grafana $GOPATH/src/github.com/grafana/grafana
### Building the backend
```bash
cd $GOPATH/src/github.com/grafana/grafana
go run build.go setup (only needed once to install godep)
godep restore (will pull down all golang lib dependencies in your current GOPATH)
go run build.go setup
go run build.go build
```

Expand All @@ -126,7 +124,7 @@ grunt watch
```

### Recompile backend on source change
To rebuild on source change (requires that you executed godep restore)
To rebuild on source change.
```bash
go get github.com/Unknwon/bra
bra run
Expand Down
10 changes: 5 additions & 5 deletions docs/sources/project/building_from_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@ go get github.com/grafana/grafana
## Building the backend
```
cd $GOPATH/src/github.com/grafana/grafana
go run build.go setup # (only needed once to install godep)
$GOPATH/bin/godep restore # (will pull down all golang lib dependencies in your current GOPATH)
go run build.go build # (or 'go build .')
go run build.go setup
go run build.go build # (or 'go build ./pkg/cmd/grafana-server')
```

#### Building on Windows
Expand All @@ -45,7 +44,7 @@ grunt
```

## Recompile backend on source change
To rebuild on source change (requires that you executed godep restore)
To rebuild on source change
```
go get github.com/Unknwon/bra
bra run
Expand All @@ -63,9 +62,10 @@ If you built it with `go build .`, run `./grafana`
Open grafana in your browser (default [http://localhost:3000](http://localhost:3000)) and login with admin user (default user/pass = admin/admin).

## Developing for Grafana
To add features, customize your config, etc, you'll need to rebuild on source change (requires that you executed [godep restore](#build-the-backend), as outlined above).
To add features, customize your config, etc, you'll need to rebuild on source change.
```
go get github.com/Unknwon/bra
bra run
```
You'll also need to run `grunt watch` to watch for changes to the front-end.
Expand Down
9 changes: 0 additions & 9 deletions pkg/Godeps/Godeps.json

This file was deleted.

5 changes: 0 additions & 5 deletions pkg/Godeps/Readme

This file was deleted.

0 comments on commit 6be4826

Please sign in to comment.