# varnam-macOS

**Repository Path**: shikisuen/varnam-macOS

## Basic Information

- **Project Name**: varnam-macOS
- **Description**: Easily type Indian languages on macOS.
- **Primary Language**: Swift
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-06
- **Last Updated**: 2022-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# VarnamIME for macOS

Easily type Indian languages on macOS using [Varnam transliteration engine](https://varnamproject.github.io/).

## Installation

[See this](https://varnamproject.com/download/mac/)

See a demo of how Varnam works: https://www.youtube.com/watch?v=7bvahY0sdWo

## Building

* Make sure XCode is installed
* Clone and do `git submodule update --init`
* `cd Installation && ./build`
* Run the newly built `VarnamIME.pkg` installer

## About

Built at FOSSUnited's [FOSSHack21](https://fossunited.org/fosshack/2021/project?project=Type%20Indian%20Languages%20natively%20on%20Mac).

This project is a hard-fork of [lipika-ime](https://github.com/ratreya/Lipika_IME)

### Resources

There aren't many documentation on how to make IMEs for macOS, especially in **English**. Getting started with XCode is also tricky for beginners. Setting up **Lipika** was also difficult.

Resources that helped in making IME on macOS (ordered by most important to the least):
* https://blog.inoki.cc/2021/06/19/Write-your-own-IME-on-macOS-1/ (The last section is very important!)
* https://jyhong836.github.io/tech/2015/07/29/add-3rd-part-dynamic-library-dylib-to-xcode-target.html
* https://github.com/lennylxx/google-input-tools-macos (An IME made 2 months ago, Has GitHub CI builds)
* https://github.com/nh7a/hiragany (Simple Japanese IME)
* https://github.com/pkamb/NumberInput_IMKit_Sample/issues/1
* API Docs: https://developer.apple.com/documentation/inputmethodkit/imkcandidates

### License

> Copyright (C) 2018 Ranganath Atreya
>
> Copyright (C) 2021 Subin Siby

```
This program is free software: you can redistribute it and/or modify it under the terms of the GNU 
General Public License as published by the Free Software Foundation; either version 3 of the License, 
or (at your option) any later version.

This program comes with ABSOLUTELY NO WARRANTY; see LICENSE file.
```