Skip to content

Commit

Permalink
Add README.rst for GitHub sake
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasT committed Jan 4, 2012
1 parent 0e82dc8 commit bc27f78
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.rst
@@ -0,0 +1,23 @@
Erakoon
=======
Erakoon_ is a proof-of-concept Erlang_ client for the Arakoon_ distributed
key-value store.

Currently, it does not support the latest Arakoon protocol format, and as such
can't be used with recent servers. Some work would be required to update the
code accordingly.

.. _Erakoon: http://github.com/Incubaid/erakoon
.. _Erlang: http://www.erlang.org
.. _Arakoon: http://arakoon.org

Building and Testing
--------------------
Erakoon uses the build system included in Erlang/OTP releases and contains an
``Emakefile`` accordingly. There's a utility ``Makefile`` to execute the
necessary actions, use ``make`` to build or ``make test`` to run the
test-suite.

The tests are executed using the ``prove`` utility found in the Perl
*Test-Harness* package, which is a dependency, as well as the Erlang ``etap``
package.

0 comments on commit bc27f78

Please sign in to comment.