.. -*- rst -*-

How to build Groonga at the repository by CMake on Windows
==========================================================

This document describes how to build Groonga at the repository by
CMake on Windows.

If you want to use GNU/Linux or Unix for developing Groonga, see
:doc:`unix_cmake`.

Unix is \*BSD, Solaris, OS X and so on.

Install depended software
-------------------------

  * `Microsoft Visual Studio Community
    <https://visualstudio.microsoft.com/vs/community/>`_
  * `CMake <http://www.cmake.org/>`_
  * `Ruby <https://www.ruby-lang.org/>`_

    * `RubyInstaller for Windows <http://rubyinstaller.org/>`_ is
      recommended.

  * `Git <https://git-scm.com/>`_: There are some Git clients for
    Windows. For example:

    * `The official Git package <https://git-scm.com/download/win>`_
    * `TortoiseGit <https://tortoisegit.org/>`_
    * `Git for Windows <https://git-for-windows.github.io/>`_
    * `GitHub Desktop <https://desktop.github.com/>`_

Checkout Groonga from the repository
------------------------------------

Users use released source archive. But developers must build Groonga
at the repository. Because source code in the repository is the
latest.

The Groonga repository is hosted on `GitHub
<https://github.com/groonga/groonga>`_. Checkout the latest source
code from the repository::

  > git clone --recursive git@github.com:groonga/groonga.git

Run ``cmake``
-------------

See :ref:`cmake-run`.

Build Groonga
-------------

See :ref:`cmake-build-and-install`.

Developers should specify ``--config Debug`` for debugging.

See also
--------

  * :doc:`/contribution/development/test`
