User Manual
===========

Welcome to the WiMarka User Manual! This guide provides comprehensive instructions for installing, configuring, and using WiMarka to evaluate machine translations.

WiMarka is designed to be accessible to users with varying levels of technical expertise, offering both a Python library interface for developers and a command-line interface (CLI) for quick evaluations.

What You'll Find Here
---------------------

This User Manual covers:

* **Installation**: Step-by-step instructions for setting up WiMarka on your system
* **Quick Start**: Get up and running with WiMarka in minutes
* **Python Library Usage**: Integrate WiMarka into your Python projects
* **CLI Usage**: Use WiMarka from the command line
* **Supported Languages**: Learn about language support and combinations
* **Output Format**: Understand evaluation results and metrics
* **Examples**: Real-world usage scenarios and best practices

Who This Manual Is For
----------------------

This manual is intended for:

* **Researchers**: Evaluating machine translation systems for Philippine languages
* **Developers**: Integrating translation evaluation into applications
* **Linguists**: Analyzing translation quality and errors
* **Students**: Learning about machine translation evaluation

Getting Started
---------------

If you're new to WiMarka, we recommend following this path:

1. :doc:`installation` - Install WiMarka and its prerequisites
2. :doc:`quickstart` - Run your first evaluation
3. :doc:`usage_library` or :doc:`usage_cli` - Choose your preferred interface
4. :doc:`examples` - Explore real-world usage scenarios

For Technical Details
---------------------

If you're looking for technical documentation about WiMarka's architecture, API, or development guidelines, please refer to the :doc:`../tech/index`.

Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   quickstart
   usage_library
   usage_cli
   supported_languages
   output_format
   examples