parent
bdc4c3ebe7
commit
6b36b5c551
@ -1,17 +0,0 @@ |
||||
### 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. |
@ -0,0 +1,40 @@ |
||||
### Setup your Minio Github Repository |
||||
Fork [Minio upstream](https://github.com/Minio-io/minio/fork) 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 |
||||
$ git clone https://github.com/$USER_ID/minio |
||||
$ cd minio |
||||
$ mkdir -p ${GOPATH}/src/github.com/minio-io |
||||
$ ln -s ${PWD} $GOPATH/src/github.com/minio-io/ |
||||
``` |
||||
|
||||
### Compiling Minio from source |
||||
Minio uses ``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 if proper environment variables are set.. Done |
||||
... |
||||
Checking dependencies for Minio.. Done |
||||
... |
||||
... |
||||
Installed minio into /home/userid/work/minio/gopath/bin |
||||
Installed new-cmd into /home/userid/work/minio/gopath/bin |
||||
``` |
||||
### Developer Guidelines |
||||
|
||||
``minio`` community welcomes your contribution. 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. |
@ -1,38 +1,21 @@ |
||||
## Introduction |
||||
|
||||
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Minio-io/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
||||
|
||||
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. |
||||
|
||||
### Install BUILD dependencies |
||||
|
||||
[Build Dependencies](./DEVELOPERS.md) |
||||
|
||||
### Setup your Minio Github Repository |
||||
Fork [Minio upstream](https://github.com/Minio-io/minio/fork) 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 |
||||
``` |
||||
### Download |
||||
|
||||
### Compiling Minio from source |
||||
Minio uses ``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 |
||||
``` |
||||
-- No releases have been made yet -- |
||||
|
||||
### Join Community |
||||
|
||||
* [Howto Contribute](./CONTRIB.md) |
||||
* [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Minio-io/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
||||
* IRC join channel #minio @ irc.freenode.net |
||||
* Google Groups - minio-dev@googlegroups.com |
||||
|
||||
### Developers |
||||
|
||||
* [Get Source](./DEVELOPER.md) |
||||
* [Build Dependencies](./BUILDDEPS.md) |
||||
* [Development Workflow](./DEVELOPER.md#developer-guidelines) |
||||
|
||||
[![Analytics](https://ga-beacon.appspot.com/UA-56860620-3/minio/readme)](https://github.com/igrigorik/ga-beacon) |
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue