Metadata-Version: 2.1
Name: plover-maajik
Version: 1.0.0b2
Summary: Cantonese steno system plugin for Plover
Author: Samuel Lo
Author-email: Sammi de Guzman <sammi@sammdot.ca>
License: Copyright (c) 2022 Sammi de Guzman, Samuel Lo, and MaaJik contributors        
        Permission is hereby granted, free of charge, to any person obtaining
        a copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.        
Project-URL: repository, https://github.com/sammdot/plover-maajik
Project-URL: homepage, https://github.com/sammdot/plover-maajik
Keywords: plover,plover_plugin
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: plover (>=4.0.0.dev11)

# MaaJik / 孖翼

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/sammdot/plover-maajik)
![PyPI](https://img.shields.io/pypi/v/plover-maajik)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/sammdot/plover-maajik/build)
![GitHub](https://img.shields.io/github/license/sammdot/plover-maajik)

MaaJik /ma˥ jɪk˨/ (孖翼, "a pair of wings") is a work-in-progress Cantonese
machine shorthand theory. This repository contains an implementation of it for
Plover, including a system plugin and dictionaries.

![MaaJik keyboard layout](https://raw.githubusercontent.com/sammdot/plover-maajik/main/assets/layout.png)

![MaaJik writing demo](https://raw.githubusercontent.com/sammdot/plover-maajik/main/assets/demo.png)

## Installation

1. Install the `plover-maajik` package through Plover's Plugins Manager.
2. Restart Plover.
3. Go to Configure > System, and change your system to `MaaJik`.

## Usage

TODO, but for now here's a link to the Steno Explainers:

![MaaJik Steno Explainers](https://steno.sammdot.ca/maajik.png)
