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

Requirements
------------

``xettel`` needs Python >=3.7 and the ``xapian`` librairy and Python bindings.
For instance, on void-linux, run the following command:

.. todo::
   Check this is the right version. May not run because of type-hints. If it fails, try python 3.9.

.. code-block:: sh

   $ sudo xbps-install libxapian xapian-core-*

Once this is done, clone the repository and install it with pip

.. code-block:: sh
  
   $ hg clone https://hg.sr.ht/~xaltsc/xettel
   $ cd xettel
   $ pip install .

You can check that ``xettel`` has been installed by running

.. code-block:: sh
   
   $ xettel --help