Permalink
Browse files

added readme

  • Loading branch information...
1 parent 206e7bb commit 376552dbd6d358e649091a156a17c1085be9c0ff @schofield schofield committed Feb 28, 2011
Showing with 35 additions and 0 deletions.
  1. +35 −0 README.org
View
@@ -0,0 +1,35 @@
+* riak_kv
+** Overview
+Riak KV is an open source Erlang application that is distributed using the [[https://github.com/basho/riak_core][riak_core]] Erlang
+library. Riak KV provides a key/value datastore and features MapReduce, lightweight data relations, and several different client APIs.
+
+** Quick Start
+ You must have [[http://erlang.org/download.html][Erlang/OTP R13B04]] or later and a GNU-style build
+ system to compile and run =riak_kv=. The easiest way to utilize riak_kv is by installing the full
+ Riak application available on [[https://github.com/basho/riak][Github]].
+
+** Contributing
+ We encourage contributions to =riak_kv= from the community.
+
+ 1) Fork the =riak_kv= repository on [[https://github.com/basho/riak_kv][Github]].
+ 2) Clone your fork or add the remote if you already have a clone of
+ the repository.
+#+BEGIN_SRC shell
+git clone git@github.com:yourusername/riak_kv.git
+# or
+git remote add mine git@github.com:yourusername/riak_kv.git
+#+END_SRC
+ 3) Create a topic branch for your change.
+#+BEGIN_SRC shell
+git checkout -b some-topic-branch
+#+END_SRC
+ 4) Make your change and commit. Use a clear and descriptive commit
+ message, spanning multiple lines if detailed explanation is
+ needed.
+ 5) Push to your fork of the repository and then send a pull-request
+ through Github.
+#+BEGIN_SRC shell
+git push mine some-topic-branch
+#+END_SRC
+ 6) A Basho engineer or community maintainer will review your patch
+ and merge it into the main repository or send you feedback.

0 comments on commit 376552d

Please sign in to comment.