mirror of https://github.com/minio/minio.git
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
## Introduction
|
|
|
|
[](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
|
|
```
|
|
|
|
### 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
|
|
```
|
|
|
|
### Join Community
|
|
|
|
* [Howto Contribute](./CONTRIB.md)
|
|
* IRC join channel #minio @ irc.freenode.net
|
|
* Google Groups - minio-dev@googlegroups.com
|
|
|
|
[](https://github.com/igrigorik/ga-beacon)
|