# README

Groonga is an open-source fulltext search engine and column store.

## Reference manual

See doc/source/ directory or https://groonga.org/docs/.

Here are shortcut links:

  * How to install: https://groonga.org/docs/install.html
  * Tutorial: https://groonga.org/docs/tutorial.html
  * How to build as a developer: https://groonga.org/docs/contribution/development/build.html

## Community

See our Community page: https://groonga.org/docs/community.html

## Bundled software

### mruby

  * Path: vendor/mruby-source
  * License: The MIT license. See vendor/mruby-source/MITL for details.

### Onigmo

  * Path: vendor/onigmo-source
  * License: BSD license. See vendor/onigmo-source/COPYING for details.

### Zulip icon

  * Path: doc/source/images/zulip-icon-128x128.png
  * License: The Apache 2.0 license. The icon is from Zulip (https://zulip.com/).
    Copyright 2011-2020 Dropbox, Inc., Kandra Labs, Inc., and contributors.
    See https://github.com/zulip/zulip/blob/main/LICENSE for details.

## Authors

### Primary authors

  * Daijiro MORI <morita at razil. jp>
  * Tasuku SUENAGA <a at razil. jp>
  * Yutaro Shimamura <yu at razil. jp>
  * Kouhei Sutou <kou at cozmixng. org>
  * Kazuho Oku <kazuhooku at gmail. com>
  * Moriyoshi Koizumi <moriyoshi at gmail. com>

### Patches and modules from

TODO: Update or use
https://github.com/groonga/groonga/graphs/contributors instead.

  * Daisuke Maki <dmaki at cpan. org>
  * Kazuhiro Osawa <ko at yappo. ne. jp>
  * Hiroyuki OYAMA <oyama at module. jp>
  * Nguyen Anh Phu <phuna at users. sourceforge. net>
  * Hideyuki KUROSU <hideyuki. kurosu at gmail. com>
  * Takuo Kitame <kitame at valinux. co. jp>
  * Yoshihiro Oyama <yos-o at smilemark. com>
  * cZfSunOs.U <sunos at saita. ma>
