====
nimothello
====

|nimble-version| |nimble-install| |gh-actions|

A teminal othello (reversi) in Nim.

Linux demo:

|demo-linux|

Windows demo:

|demo-windows|

.. contents:: Table of contents

Usage
=====

.. code-block:: shell

   $ nimothello

Key bindings
^^^^^^^^^^^^

Vim like key-bindings.

=============== =======
Key             Motion
=============== =======
H / A           Move left
J / S           Move down
K / W           Move up
L / D           Move right
<Space>/<Enter> Put cell
=============== =======

Installation
============

.. code-block:: shell

   $ nimble install -Y nimothello

LICENSE
=======

MIT

Development
===========

Release workflow
^^^^^^^^^^^^^^^^

GitHub Action runs when you pushed new tags.

.. code-block:: shell

   $ git tag <new_tag>
   $ git push origin <new_tag>

   or

   $ git push origin --tags

GitHub Action creates a new release and upload your assets.

Release workflows:

|image-release-workflow|

Release note will be generated by `git-chglog <https://github.com/git-chglog/git-chglog>`_.
Config files are `.chglog <./.chglog>`_.

Details, see `release.yml <./.github/workflows/release.yml>`_.

.. |gh-actions| image:: https://github.com/jiro4989/nimothello/workflows/test/badge.svg
   :target: https://github.com/jiro4989/nimothello/actions
.. |nimble-version| image:: https://nimble.directory/ci/badges/nimothello/version.svg
   :target: https://nimble.directory/ci/badges/nimothello/nimdevel/output.html
.. |nimble-install| image:: https://nimble.directory/ci/badges/nimothello/nimdevel/status.svg
   :target: https://nimble.directory/ci/badges/nimothello/nimdevel/output.html

.. |image-release-workflow| image:: https://user-images.githubusercontent.com/13825004/87944618-9897fc00-cada-11ea-9401-74167f04b5c4.png

.. |demo-linux| image:: https://raw.githubusercontent.com/jiro4989/nimothello/master/docs/othello_linux.gif.gif
.. |demo-windows| image:: https://raw.githubusercontent.com/jiro4989/nimothello/master/docs/othello_win.gif.gif