mirror of
				https://github.com/optim-enterprises-bv/kubernetes.git
				synced 2025-11-04 04:08:16 +00:00 
			
		
		
		
	Fix up the docs somewhat.
This commit is contained in:
		
							
								
								
									
										19
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										19
									
								
								README.md
									
									
									
									
									
								
							@@ -64,12 +64,27 @@ The commands above will not work if there are more than one directory in ``$GOPA
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
### godep and dependency management
 | 
					### godep and dependency management
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Kubernetes uses [godep](https://github.com/tools/godep) to manage dependencies. Please make sure that ``godep`` is installed and in your ``$PATH``. If you have already set up Go development environment correctly, the following command will install ``godep`` into your ``$GOBIN`` directory, which is ``$GOPATH/bin`` by default if ``$GOBIN`` is not set:
 | 
					Kubernetes uses [godep](https://github.com/tools/godep) to manage dependencies. Please make sure that ``godep`` is installed and in your ``$PATH``.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Installing godep
 | 
				
			||||||
 | 
					There are many ways to build and host go binaries. Here is an easy way to get utilities like ```godep``` installed:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Ensure that [mercurial](http://mercurial.selenic.com/wiki/Download) is installed on your system. (some of godep's dependencies use the mercurial
 | 
				
			||||||
 | 
					source control system).  Use ```apt-get install mercurial``` or ```yum install mercurial``` on Linux, or [brew.sh](http://brew.sh) on OS X, or download
 | 
				
			||||||
 | 
					directly from mercurial.
 | 
				
			||||||
 | 
					2. Create a new GOPATH for your tools and install godep:
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
go get github.com/tools/godep
 | 
					GOPATH=$HOME/src/go-tools
 | 
				
			||||||
 | 
					mkdir -p $GOPATH
 | 
				
			||||||
 | 
					go install github.com/tools/godep
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					3. Add $HOME/src/go-tools/bin to your path. Typically you'd add this to your ~/.profile:
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					export PATH=$PATH:$HOME/src/go-tools/bin
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Using godep
 | 
				
			||||||
Here is a quick summary of `godep`.  `godep` helps manage third party dependencies by copying known versions into Godep/_workspace.  You can use `godep` in three ways:
 | 
					Here is a quick summary of `godep`.  `godep` helps manage third party dependencies by copying known versions into Godep/_workspace.  You can use `godep` in three ways:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. Use `godep` to call your `go` commands.  For example: `godep go test ./...`
 | 
					1. Use `godep` to call your `go` commands.  For example: `godep go test ./...`
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -9,12 +9,7 @@
 | 
				
			|||||||
4. You must have Go (version 1.2 or later) installed: [www.golang.org](http://www.golang.org).
 | 
					4. You must have Go (version 1.2 or later) installed: [www.golang.org](http://www.golang.org).
 | 
				
			||||||
5. You must have the [`gcloud` components](https://developers.google.com/cloud/sdk/) installed.
 | 
					5. You must have the [`gcloud` components](https://developers.google.com/cloud/sdk/) installed.
 | 
				
			||||||
6. Ensure that your `gcloud` components are up-to-date by running `gcloud components update`.
 | 
					6. Ensure that your `gcloud` components are up-to-date by running `gcloud components update`.
 | 
				
			||||||
7. Install godep:
 | 
					7. Install godep. [Instructions here](https://github.com/GoogleCloudPlatform/kubernetes#installing-godep)
 | 
				
			||||||
   ```sh
 | 
					 | 
				
			||||||
   export GOBIN=/usr/local/go/bin
 | 
					 | 
				
			||||||
   go get github.com/tools/godep
 | 
					 | 
				
			||||||
   ```
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
8. Get the Kubernetes source:
 | 
					8. Get the Kubernetes source:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        git clone https://github.com/GoogleCloudPlatform/kubernetes.git
 | 
					        git clone https://github.com/GoogleCloudPlatform/kubernetes.git
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -18,11 +18,7 @@
 | 
				
			|||||||
   go get github.com/vmware/govmomi/govc
 | 
					   go get github.com/vmware/govmomi/govc
 | 
				
			||||||
   ```
 | 
					   ```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
5. Install godep:
 | 
					5. Install godep. [Instructions here](https://github.com/GoogleCloudPlatform/kubernetes#installing-godep)
 | 
				
			||||||
 | 
					 | 
				
			||||||
   ```sh
 | 
					 | 
				
			||||||
   go get github.com/tools/godep
 | 
					 | 
				
			||||||
   ```
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
6. Get the Kubernetes source:
 | 
					6. Get the Kubernetes source:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user