diff --git a/README.md b/README.md index c9e48a3bd90..0a969f248d8 100644 --- a/README.md +++ b/README.md @@ -87,11 +87,11 @@ the latest master builds [here](http://grafana.org/builds) go get github.com/grafana/grafana ``` -Since imports of dependencies use the absolute path github.com/grafana/grafana within the $GOPATH, -you will need to put your version of the code in $GOPATH/src/github.com/grafana/grafana to be able +Since imports of dependencies use the absolute path `github.com/grafana/grafana` within the `$GOPATH`, +you will need to put your version of the code in `$GOPATH/src/github.com/grafana/grafana` to be able to develop and build grafana on a cloned repository. To do so, you can clone your forked repository -directly to $GOPATH/src/github.com/grafana or you can create a symbolic link from your version -of the code to $GOPATH/src/github.com/grafana/grafana. The last options makes it possible to change +directly to `$GOPATH/src/github.com/grafana` or you can create a symbolic link from your version +of the code to `$GOPATH/src/github.com/grafana/grafana`. The last options makes it possible to change easily the grafana repository you want to build. ```bash go get github.com/*your_account*/grafana @@ -108,7 +108,7 @@ go run build.go build ### Building frontend assets -To build less to css for the frontend you will need a recent version of of **node (v4+)**, +To build less to css for the frontend you will need a recent version of **node (v4+)**, npm (v2.5.0) and grunt (v0.4.5). Run the following: ```bash @@ -135,7 +135,7 @@ bra run ./bin/grafana-server ``` -Open grafana in your browser (default http://localhost:3000) and login with admin user (default user/pass = admin/admin). +Open grafana in your browser (default: `http://localhost:3000`) and login with admin user (default: `user/pass = admin/admin`). ### Dev config @@ -147,7 +147,7 @@ You only need to add the options you want to override. Config files are applied 3. custom.ini ## Create a pull request -Before or after you create a pull request, sign the [contributor license agreement](http://grafana.org/docs/contributing/cla.html). +Before or after you create a pull request, sign the [contributor license agreement](http://docs.grafana.org/project/cla/). ## Contribute If you have any idea for an improvement or found a bug do not hesitate to open an issue.