Welcome to Jiwar's documentation!
=================================

Jiwar: A neighborhood calculator for 40+ languages
--------------------------------------------------

.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
   :target: https://www.gnu.org/licenses/gpl-3.0
   :alt: License: GPL v3

.. image:: https://img.shields.io/badge/Colab-F9AB00?style=for-the-badge&logo=googlecolab&color=525252
   :alt: Google Colab

.. image:: https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue
   :alt: Python

Jiwar is an open-source Python tool for generating orthographic, phonological, and phonographic measures across 40+ languages.

Features
--------

- Supports 40+ languages
- Calculates orthographic, phonological, and phonographic neighborhood measures
- User-friendly command-line interface
- Includes built-in and custom corpus files

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   usage
   measures/index
   languages/index
   advanced/index