Commit b7c8fb62 authored by Leif Walsh's avatar Leif Walsh

first draft of readme

parent a2974b0c
TokuDB
======
TokuDB is a high-performance, transactional storage engine for MySQL and
MariaDB. For more details, see our [product page][products].
This repository contains the MySQL plugin that uses the [TokuKV][tokukv].
There are also patches to the MySQL and MariaDB kernels, available in our
forks of [mysql][mysql] and [mariadb][mariadb].
[products]: http://www.tokutek.com/products/tokudb-for-mysql/
[tokukv]: http://github.com/Tokutek/ft-index
[mysql]: http://github.com/Tokutek/mysql
[mariadb]: http://github.com/Tokutek/mariadb
Building
--------
The `scripts/` directory contains a script that can be used to build a
working MySQL or MariaDB with Tokutek patches, and with the TokuDB storage
engine, called `make.mysql.bash`. This script will download copies of the
needed source code from github and build everything.
To build MySQL with TokuDB 7.0.0:
```sh
scripts/make.mysql.bash --git_tag=tokudb-7.0.0
```
To build MariaDB with TokuDB 7.0.0:
```sh
scripts/make.mysql.bash --git_tag=tokudb-7.0.0 --mysql=mariadb-5.5.30
```
Contributing
------------
Please report bugs in TokuKV here on github.
We have two publicly accessible mailing lists:
- tokudb-user@googlegroups.com is for general and support related
questions about the use of TokuDB, TokuKV, and TokuDS.
- tokudb-dev@googlegroups.com is for discussion of the development of
TokuDB, TokuKV, and TokuDS.
We are also available on IRC on freenode.org, in the #tokutek channel.
License
-------
TokuDB is available under the GPL version 2. See [COPYING][copying].
TokuKV (a component of TokuDB) is available under the GPL with slight
modifications. See [README-TOKUDB][license] in the ft-index repository.
[copying]: http://github.com/Tokutek/ft-engine/blob/master/COPYING
[license]: http://github.com/Tokutek/ft-index/blob/master/README-TOKUDB
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment