Skip to content
/ kana Public

[mirror] CLI program for transliterating romaji text to either hiragana or katakana

License

Notifications You must be signed in to change notification settings

gbrlsnchs/kana

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kana

kana is a CLI tool and also a library for transliterating romaji text to either hiragana (ひらがな) or katakana (カタカナ).

Usage

The following snippets only shortly demonstrate the features. For a more thorough documentation, see kana(1).

$ kana <<< 'ohayougozaimasu'
おはようございます

Katakana

$ kana --katakana <<< 'suupa mario'
スーパ マリオ

Extended katakana

$ kana --katakana --extended <<< 'supagetti'
スパゲッティ

Punctuation marks

$ kana --punctuation <<< 'soudesune.'
そうですね。
$ kana --punctuation <<< 'kawaii~'
かわいい〜
$ kana --punctuation <<< 'nani?!'
なに?!
$ kana --punctuation <<< "'hiragana'"
「ひらがな」
$ kana --punctuation <<< '"katakana"'
『カタカナ』
$ kana --punctuation <<< '([{<sugoi>}])'
([{【すごい】}])

Forcing prolongation (hiragana only)

$ kana --force-prolongation <<< 'raamen'
らーめん

Toggling between kanas

$ kana --kana-toggle='@' <<< 'watashiha@gaburieru@desu'
わたしはガブリエルです

Toggling between raw text and kanas

$ kana --raw-toggle='#' <<< 'watashiha#J-rock#gasukidesu'
わたしはJ-rockがすきです

Resetting prolongation

$ kana --katakana --prolongation-reset='^' <<< 'Pikachu^u'
ピカチュウ

Using small vowels

$ kana --katakana --vowel-shortener='_' <<< 'Keeshi_i'
ケーシィ

Adding virtual stops

$ kana --katakana --virtual-stop='%' <<< 'U%u'
ウッウ

Contributing

Use the mailing list to

  • Report issues
  • Request new features
  • Send patches
  • Discuss development in general

If applicable, a new ticket will be submitted by maintainers to the issue tracker in order to track confirmed bugs or new features.

Building and distributing the project

This project is built entirely in Zig. Build it as you wish for local usage, and package it to your distro of preference in accordance with its policy on how to package Zig projects.

You can generate man pages in doc/ by using scdoc.

About

[mirror] CLI program for transliterating romaji text to either hiragana or katakana

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages