Metadata-Version: 2.4
Name: lute3-cantonese
Version: 0.0.2
Summary: Learning Using Texts - Cantonese Parser
Author: chengxicn
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: lute3>=3.4.2
Requires-Dist: pycantonese>=3.4.0

# `lute3-cantonese`

A Cantonese parser for Lute (`lute3`) using the
[pycantonese](https://pycantonese.org) library.

## Installation

See the [Lute manual](https://luteorg.github.io/lute-manual/install/plugins.html).

## Usage

When this parser is installed, you can add "Cantonese Chinese" as a
language to Lute, which comes with a simple story.

## Segmentation

pycantonese segments text using longest-string matching, trained on
the HKCanCor corpus and the rime-cantonese word list.  Both
traditional and simplified characters are handled, though the
training data is traditional-oriented, so traditional texts are
segmented more accurately.

## Readings

Terms are romanized using Jyutping (e.g. 你好 → nei5 hou2), shown
in the reading box if `show_romanization` is enabled.

