minio/README.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

2014-11-30 13:55:10 -08:00
## Introduction
2014-11-22 21:25:07 -08:00
2014-12-23 00:38:08 +00:00
[![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)
2014-11-30 13:55:10 -08:00
Minio is an open source object storage released under [Apache license v2](./LICENSE) . It uses ``Rubberband Erasure`` coding to dynamically protect the data.
2014-12-14 15:03:32 -08:00
Minio's design is inspired by Amazon's S3 for its API and Facebook's Haystack for its immutable data structure.
2014-11-22 21:25:07 -08:00
2014-12-20 09:09:35 -08:00
### Install BUILD dependencies
2014-12-20 09:09:35 -08:00
[Build Dependencies](./DEVELOPERS.md)
2014-12-20 09:23:06 -08:00
### 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.
2014-12-20 09:09:35 -08:00
```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
2014-12-20 09:23:06 -08:00
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``.
2014-12-20 09:09:35 -08:00
```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
```
2014-12-12 23:49:26 -08:00
### Join Community
2014-12-20 09:23:06 -08:00
* [Howto Contribute](./CONTRIB.md)
2014-12-12 23:49:26 -08:00
* IRC join channel #minio @ irc.freenode.net
* Google Groups - minio-dev@googlegroups.com
2014-11-27 02:49:20 -08:00
[![Analytics](https://ga-beacon.appspot.com/UA-56860620-3/minio/readme)](https://github.com/igrigorik/ga-beacon)