Update the README with new information and formatting

pull/34/head
Lucas Käldström 2016-05-01 18:47:27 +03:00
parent 248b6941d0
commit 65cf6ef62c
1 changed files with 27 additions and 22 deletions

View File

@ -34,28 +34,32 @@ For more information about minikube, see the [proposal](https://github.com/kuber
## Build Instructions
go build -o minikube cli/main.go
```shell
./build.sh
```
## Run Instructions
Start the cluster with:
./minikube start
Starting local Kubernetes cluster...
2016/04/19 11:41:26 Machine exists!
2016/04/19 11:41:27 Kubernetes is available at http://192.168.99.100:8080.
2016/04/19 11:41:27 Run this command to use the cluster:
2016/04/19 11:41:27 kubectl config set-cluster minikube --insecure-skip-tls-verify=true --server=http://192.168.99.100:8080
```console
$ ./minikube start
Starting local Kubernetes cluster...
2016/04/19 11:41:26 Machine exists!
2016/04/19 11:41:27 Kubernetes is available at http://192.168.99.100:8080.
2016/04/19 11:41:27 Run this command to use the cluster:
2016/04/19 11:41:27 kubectl config set-cluster minikube --insecure-skip-tls-verify=true --server=http://192.168.99.100:8080
```
Access the cluster with:
Access the cluster by adding `-s=http://192.168.x.x:8080` to every `kubectl` command, or run the commands below:
First run the command from above:
```shell
kubectl config set-cluster minikube --insecure-skip-tls-verify=true --server=http://192.168.99.100:8080
kubectl config set-context minikube --cluster=minikube
kubectl config use-context minikube
```
kubectl config set-cluster minikube --insecure-skip-tls-verify=true --server=http://192.168.99.100:8080
Then use kubectl normally:
kubectl get pods --cluster=minikube
by running those commands, you may use `kubectl` normally
## Development
@ -67,15 +71,16 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for an overview of how to send pull reque
Unit tests are run on Travis before code is merged. To run as part of a development cycle:
go test $(go list ./... | grep -v /vendor/)
```shell
go test $(go list ./... | grep -v /vendor/)
```
#### Integration Tests
Integration tests are currently run manually. To run them, first build the binary:
go build -o minikube cli/main.go
Then test it:
go test ./integration --tags=integration
Integration tests are currently run manually.
To run them, build the binary and run the tests:
```shell
./build.sh
go test ./integration --tags=integration
```