https://github.com/yelinaung/mmfont

A simple Ruby gem which converts zawgyi1 <=> unicode strings
https://github.com/yelinaung/mmfont

Last synced: 3 months ago
JSON representation

A simple Ruby gem which converts zawgyi1 <=> unicode strings

• Host: GitHub
• URL: https://github.com/yelinaung/mmfont
• Owner: yelinaung
• License: mit
• Created: 2014-07-26T09:12:29.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-04-17T05:31:08.000Z (over 9 years ago)
• Last Synced: 2024-05-16T11:32:34.901Z (8 months ago)
• Language: Ruby
• Homepage:
• Size: 244 KB
• Stars: 2
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-myanmar-unicode - mmfont - A simple Ruby gem which converts zawgyi <=> unicode strings (Libraries)

README

        
# Mmfont

[![Build Status](https://travis-ci.org/yelinaung/mmfont.svg)](https://travis-ci.org/yelinaung/mmfont)

[![Gem Version](https://badge.fury.io/rb/mmfont.svg)](http://badge.fury.io/rb/mmfont)

[![Dependency Status](https://gemnasium.com/yelinaung/mmfont.svg)](https://gemnasium.com/yelinaung/mmfont)

[![Inline docs](http://inch-ci.org/github/yelinaung/mmfont.png?branch=master)](http://inch-ci.org/github/yelinaung/mmfont)

A simple gem which converts zawgyi1 <=> unicode strings. It uses the rules from [paytan](https://github.com/trhura/paytan) and basically, the ruby converter.

It's written with TDD. Special thanks to [@steveklabnik](https://github.com/steveklabnik) for his tutorials [How I Start Ruby](http://www.howistart.org/posts/ruby/1).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'mmfont'

```

And then execute:

```bash

$ bundle

```

Or install it yourself as:

```bash

$ gem install mmfont

```

## Usage

```ruby

require 'mmfont'

mmfont = Mmfont::Converter.new

mmfont.uni512zg1("မင်္ဂလာပါ")  # returns zg strings "မဂၤလာပါ"

mmfont.zg12uni51("မဂၤလာပါ")   # returns unicode strings "မင်္ဂလာပါ"

```

## Is it fast ?

I am not sure. But of course, Ruby is basically slow, regardless of implementations, compared to Nodejs, Go, Rust etc. 

Some benchmarks, maybe ?

## TODO

- ~~Write TESTS!~~

## Contributing

1. Fork it ( https://github.com/yelinaung/mmfont )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## License

MIT