Merge pull request #141 from harshavardhana/pr_out_update_documentation

CONTRIB.md

@@ -0,0 +1,17 @@
+###  Contribution Guidelines
+We welcome your contributions. To make the process as seamless as possible, we ask for the following:
+* Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.
+  - Fork it
+  - Create your feature branch (git checkout -b my-new-feature)
+  - Commit your changes (git commit -am 'Add some feature')
+  - Push to the branch (git push origin my-new-feature)
+  - Create new Pull Request
+* If you have additional dependencies for ``minio``, ``minio`` manages its depedencies using [godep](https://github.com/tools/godep)
+  - Run `go get foo/bar`
+  - Edit your code to import foo/bar
+  - Run `make save` from top-level directory (or `godep restore && godep save ./...`).
+* When you're ready to create a pull request, be sure to:
+  - Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
+  - Run go fmt
+  - Squash your commits into a single commit. git rebase -i. It's okay to force update your pull request.
+  - Make sure go test -race ./... passes, and go build completes.

DEVELOPERS.md

@@ -28,37 +28,3 @@ $ mkdir -p $HOME/mygo
 $ export GOPATH=$HOME/mygo
 $ export PATH=$PATH:$GOPATH/bin
 ```
-
-### Setup your Minio Github Repository &nbsp; &nbsp; <iframe src="http://ghbtns.com/github-btn.html?user=Minio-io&repo=minio&type=fork&count=true&size=large" height="30" width="170" frameborder="0" scrolling="0" style="width:170px; height: 30px;" allowTransparency="true"></iframe>
-Fork [Minio upstream](https://github.com/Minio-io/minio) source repository to your own personal repository. Copy the URL and pass it to ``go get`` command. Go uses git to clone a copy into your project workspace folder.
-```sh
-$ go get -u github.com/$USER_ID/minio
-$ cd $GOPATH/src/github.com/$USER_ID/minio/
-$ git remote add upstream https://github.com/Minio-io/minio.git
-```
-
-### Compiling Minio from source
-Minio use plain Makefile to wrap around some of the limitations of ``go build``. To compile Minio source, simply change to your workspace folder and type ``make``.
-```sh
-$ cd $GOPATH/src/github.com/$USER_ID/minio/
-$ make
-...
-```
-
-###  Contribution Guidelines
-We welcome your contributions. To make the process as seamless as possible, we ask for the following:
-* Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.
-  - Fork it
-  - Create your feature branch (git checkout -b my-new-feature)
-  - Commit your changes (git commit -am 'Add some feature')
-  - Push to the branch (git push origin my-new-feature)
-  - Create new Pull Request
-* If you have additional dependencies for ``minio``, ``minio`` manages its depedencies using [godep](https://github.com/tools/godep)
-  - Run `go get foo/bar`
-  - Edit your code to import foo/bar
-  - Run `make save` from top-level directory (or `godep restore && godep save ./...`).
-* When you're ready to create a pull request, be sure to:
-  - Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
-  - Run go fmt
-  - Squash your commits into a single commit. git rebase -i. It's okay to force update your pull request.
-  - Make sure go test -race ./... passes, and go build completes.

Makefile

@@ -7,8 +7,8 @@ checkdeps:
 	@./checkdeps.sh
 
 getdeps: checkdeps
-	@go get github.com/tools/godep && echo "Installing godep"
-	@go get golang.org/x/tools/cmd/cover && echo "Installing cover"
+	@go get github.com/tools/godep && echo "Installed godep"
+	@go get golang.org/x/tools/cmd/cover && echo "Installed cover"
 
 build-erasure:
 	@$(MAKE) $(MAKE_OPTIONS) -C pkgs/erasure/isal lib
@@ -48,7 +48,7 @@ cover: build-erasure build-signify build-split build-crc32c build-cpu build-sha1
 
 install: build-erasure
 	@godep go install github.com/minio-io/minio/cmd/minio && echo "Installed minio into ${GOPATH}/bin"
-	@godep go install github.com/minio-io/minio/cmd/minio-cli && echo "Install minio-cli into ${GOPATH}/bin"
+	@godep go install github.com/minio-io/minio/cmd/minio-cli && echo "Installed minio-cli into ${GOPATH}/bin"
 
 save: restore
 	@godep save ./...

README.md

@@ -3,9 +3,33 @@
 Minio is an open source object storage released under [Apache license v2](./LICENSE) . It uses ``Rubberband Erasure`` coding to dynamically protect the data.
 Minio's design is inspired by Amazon's S3 for its API and Facebook's Haystack for its immutable data structure.
 
-### Build Minio from Source
+### Install BUILD dependencies
 
-[Source Install](./DEVELOPERS.md)
+[Build Dependencies](./DEVELOPERS.md)
+
+### Setup your Minio Github Repository &nbsp; &nbsp; <iframe src="http://ghbtns.com/github-btn.html?user=Minio-io&repo=minio&type=fork&count=true&size=large" height="30" width="170" frameborder="0" scrolling="0" style="width:170px; height: 30px;" allowTransparency="true"></iframe>
+Fork [Minio upstream](https://github.com/Minio-io/minio) source repository to your own personal repository. Copy the URL and pass it to ``go get`` command. Go uses git to clone a copy into your project workspace folder.
+```sh
+$ go get -u github.com/$USER_ID/minio
+$ cd $GOPATH/src/github.com/$USER_ID/minio/
+$ git remote add upstream https://github.com/Minio-io/minio.git
+```
+
+### Compiling Minio from source
+Minio use plain Makefile to wrap around some of the limitations of ``go build``. To compile Minio source, simply change to your workspace folder and type ``make``.
+```sh
+$ cd $GOPATH/src/github.com/$USER_ID/minio/
+$ make
+Checking dependencies for Minio.. SUCCESS
+...
+...
+Installed minio into /home/harsha/.gvm/pkgsets/go1.4/global/bin
+Installed minio-cli into /home/harsha/.gvm/pkgsets/go1.4/global/bin
+```
+
+### Contribute
+
+[Howto Contribute](./CONTRIB.md)
 
 ### Join Community
 

cmd/minio-cli/README.md

@@ -1,8 +1,8 @@
 ## Introduction
 
-`minio-cli` is cli option stub builder for ``minio`` project on top of [codegangsta/cli](https://github.com/codegangsta/cli),
+`minio-cli` is a stub builder for new commands,options on top of [codegangsta/cli](https://github.com/codegangsta/cli),
 
-Ideal for rapid prototyping and encouraging new contributors to the project
+Idea behind providing a simple tool for rapid prototyping and encouraging new contributors to the project
 
 ## Usage
 
@@ -12,21 +12,14 @@ You just need to set its command name and options:
 $ minio-cli -options option1,option2,option3 [command]
 ```
 
-Generates three files namely [command].go, [command]-options.go, [application].md
+Generates three files namely [command].go, [command]-options.go, [command].md
 
 ## Example
 
 If you want to start to building `bucket` command which has options `get`, `put`, `list`:
 
 ```bash
-$ minio-cli -options get,put,list foo
-$ ls foo/
-foo-options.go  foo.go  foo.md
-```
-
-## Installation
-
-```bash
-$ go get github.com/minio-io/minio
-$ make install
+$ minio-cli -options get,put,list bucket
+$ ls bucket/
+bucket-options.go  bucket.go  bucket.md
 ```