Skip to content

Commit

Permalink
docs: cleanup and add coverage badges
Browse files Browse the repository at this point in the history
  • Loading branch information
outloudvi committed Aug 4, 2024
1 parent b942593 commit 2dabf0b
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# mw2fcitx

Build fcitx5 libraries from MediaWiki sites.
Build fcitx5/RIME dictionaries from MediaWiki sites.

[![PyPI](https://img.shields.io/pypi/v/mw2fcitx)](https://pypi.org/project/mw2fcitx/)
[![PyPI - License](https://img.shields.io/pypi/l/mw2fcitx)](https://github.com/outloudvi/mw2fcitx/blob/master/LICENSE)
[![CircleCI](https://circleci.com/gh/outloudvi/mw2fcitx.svg?style=svg)](https://circleci.com/gh/outloudvi/mw2fcitx)
[![Tests](https://github.com/outloudvi/mw2fcitx/actions/workflows/test.yml/badge.svg)](https://github.com/outloudvi/mw2fcitx/actions/workflows/test.yml)
[![codecov: Coverage](https://codecov.io/gh/outloudvi/mw2fcitx/graph/badge.svg?token=1RP1099913)](https://codecov.io/gh/outloudvi/mw2fcitx)

```sh
pip install mw2fcitx
# or if you want to just install for current user
pip install mw2fcitx --user
# or if you want to just run it (needs Pipx)
pipx run mw2fcitx
```

For the old `fcitx5-pinyin-moegirl`, see [branch v1](https://github.com/outloudvi/mw2fcitx/tree/v1).

For the pre-build moegirl dictionary info, see [the wiki](https://github.com/outloudvi/mw2fcitx/wiki/fcitx5-pinyin-moegirl).
For the pre-built moegirl dictionary info, see [the wiki](https://github.com/outloudvi/mw2fcitx/wiki/fcitx5-pinyin-moegirl).

## CLI Usage

Expand Down Expand Up @@ -75,6 +75,7 @@ exports = {
}
}, {
# pinyin is a built-in generator.
# This generator depends on `libime`.
"use": "pinyin",
"kwargs": {
# Destination dictionary filename. (mandatory)
Expand Down

0 comments on commit 2dabf0b

Please sign in to comment.