Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/OpenBangla/OpenBangla-Keyboard

An OpenSource, Unicode compliant Bengali Input Method
https://github.com/OpenBangla/OpenBangla-Keyboard

avro-phonetic bangla bengali input-method linux openbangla-keyboard ubuntu

Last synced: about 2 months ago
JSON representation

An OpenSource, Unicode compliant Bengali Input Method

Awesome Lists containing this project

README 

        
//Ref : https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74

= OpenBangla Keyboard (OBK)

ifdef::env-github[]

:imagesdir:

 https://gist.githubusercontent.com/path/to/gist/revision/dir/with/all/images

:tip-caption: :bulb:

:note-caption: :information_source:

:important-caption: :heavy_exclamation_mark:

:caution-caption: :fire:

:warning-caption: :warning:

endif::[]

ifndef::env-github[]

:imagesdir: .

endif::[]

:toc:

:toc-placement!:



++++

(বাংলায় পড়ুন)


++++



//HTML for formating the logo



++++







++++



*OpenBangla Keyboard* is an open source, Unicode compliant, Bangla input method for GNU/Linux systems.

It's a full-fledged Bangla input method with typing automation tools, includes many famous typing methods such as Avro Phonetic,

Probhat, Munir Optima, National (Jatiya) etc.



Most features of https://www.omicronlab.com/avro-keyboard.html[Avro Keyboard] are present in OpenBangla Keyboard.

So Avro Keyboard users will feel right at home in Linux with OpenBangla Keyboard.



image:https://github.com/OpenBangla/OpenBangla-Keyboard/workflows/CI/badge.svg[CI, link=https://github.com/OpenBangla/OpenBangla-Keyboard/actions?query=workflow%3ACI+branch%3Amaster] {nbsp}

image:https://img.shields.io/github/downloads/OpenBangla/OpenBangla-Keyboard/total.svg?label=GitHub%20Downloads[Github Downloads, link=https://img.shields.io/github/downloads/OpenBangla/OpenBangla-Keyboard/total.svg?label=GitHub%20Downloads] {nbsp}



CAUTION: This project is powered by github 🌟s. Go ahead and *star* it please!



🚧 🚧 *Ongoing developments happen on the https://github.com/OpenBangla/OpenBangla-Keyboard/tree/develop[`develop`] branch.* 🚧 🚧



toc::[]



== Features

* Features a __Top Bar__ like Avro Keyboard for easy configuration.

* Layout Viewer

* Phonetic Keyboard Layout (Avro Phonetic)

  ** 100% compatibility with current Avro Phonetic scheme.

  ** Dictionary support can predict and suggest phonetically similar words with correct spelling on the fly.

  ** Autocorrect feature for numerous commonly mistyped words.

  ** Autocorrect support brings commonly used English words to Bangla (like, Facebook, download etc.) even with their original English spelling.

  ** User can add and edit autocorrect entries.

  ** Support for preview window to see originally typed text right under the cursor.

* Fixed Keyboard Layout

  ** OpenBangla Keyboard comes with Probhat, Munir Optima, Avro Easy, Bornona, National (Jatiya) keyboard layouts out of the box.

  ** OpenBangla Keyboard supports Avro Keyboard Layout files (version 5).

* Typing Automation tools for Fixed Keyboard layout

  ** Automatic vowel forming.

  ** Old style "Reph".

  ** Traditional "-Kar" joining.

  ** Automatic "Chandrabindu" position fixing.



== Installation



IMPORTANT: If you had installed OpenBangla Keyboard 1.5.1 or earlier version, https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Uninstalling-OpenBangla-Keyboard[please uninstall it first.]



Open your terminal and run this command on your bash shell. NB : It has to be **BASH**, otherwise it won't work.

```bash

bash -c "$(wget -q https://raw.githubusercontent.com/OpenBangla/OpenBangla-Keyboard/master/tools/install.sh -O -)"

```



If this does not workout for you please create an https://github.com/OpenBangla/OpenBangla-Keyboard/issues[Issue]. While we look into the problem you can check the https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Installing-OpenBangla-Keyboard[Wiki] for Distrowise/Distro-specific Install Instructions.



=== Archlinux and it's derivatives

TIP: There is a video tutorial about installing OpenBangla Keyboard in Arch Linux. You may check that out from https://youtu.be/C8vnR1AY6sA[here].



There are two packages for OpenBangla Keyboard in the Arch User Repository(AUR). Use `openbangla-keyboard` if you want to make and install the package from source. Otherwise, use `openbangla-keyboard-bin` to use the binary package released for Arch and its derivatives by the maintainer. You can install it in one command with your favorite aur helper. Example commands for some popular tools:



==== `openbangla-keyboard`

* `$ pacaur -S openbangla-keyboard`

* `$ yay -S openbangla-keyboard`

* `$ yaourt -S openbangla-keyboard`



==== `openbangla-keyboard-bin`

* `$ pacaur -S openbangla-keyboard-bin`

* `$ yay -S openbangla-keyboard-bin`

* `$ yaourt -S openbangla-keyboard-bin`



Or install manually:

```bash

sudo pacman -S base-devel git

git clone https://aur.archlinux.org/openbangla-keyboard.git

cd openbangla-keyboard

makepkg -risc

```

We also provide a `.pkg.tar.zst` package for Arch Linux which you can download the installation package from https://github.com/OpenBangla/OpenBangla-Keyboard/releases[releases page] and install OpenBangla Keyboard on your system by running the following command:

```bash

$ sudo pacman -U package.pkg.tar.zst

```



=== Others

You can also install by downloading necessary packages from our https://github.com/OpenBangla/OpenBangla-Keyboard/releases[Releases] page.



=== Finally

After you have installed OpenBangla Keyboard, you may need to https://github.com/OpenBangla/OpenBangla-Keyboard/wiki/Configuring-Environment[configure your desktop environment].



If this does not work out for you, please create an https://github.com/OpenBangla/OpenBangla-Keyboard/issues[Issue.]



== Community

We are on https://github.com/OpenBangla/OpenBangla-Keyboard/discussions[Github Discussions] and https://www.facebook.com/openbanglakeyboard[Facebook].



== Compiling on GNU/Linux



OpenBangla Keyboard currently has the following build dependencies:



* GNU GCC, G++ compiler or Clang

* Rust 1.34.0 or later

* GNU Make or Ninja

* CMake

* Qt 5.5 or later

* iBus development library

* Zstandard compression library (zstd)



=== Ubuntu & Debian derivatives

On a Ubuntu/Debian system you can easily install them like this:

```bash

sudo apt-get install build-essential rustc cargo cmake libibus-1.0-dev qtbase5-dev qtbase5-dev-tools libzstd-dev

```



=== Fedora

On a Fedora system you can easily install them like this:

```bash

sudo dnf install @buildsys-build rust cargo cmake qt5-qtdeclarative-devel ibus-devel libzstd-devel

```



=== Arch Linux & it's derivatives

On a Arch Linux / Arch Based system you can easily install them like this:

```bash

sudo pacman -S base-devel rust cmake qt5-base libibus zstd

```



=== openSUSE

On openSUSE & derivatives you can easily install them like this:

```bash

sudo zypper install libQt5Core-devel libQt5Widgets-devel libQt5Network-devel libzstd-devel libzstd1 cmake make ninja rust ibus-devel ibus clang gcc patterns-devel-base-devel_basis

```



=== Solus

On Solus you can easily install them like this:

```bash

sudo eopkg install -c system.devel rust qt5-base-devel ibus-devel zstd-devel git

```



=== Finally

After you have installed required libraries and binaries, clone this repository and change to the cloned folder:

```bash

git clone --recursive https://github.com/OpenBangla/OpenBangla-Keyboard.git

cd OpenBangla-Keyboard

```



Then issue the build commands:

```bash

mkdir build && cd build

cmake ..

make

sudo make install

```



== Acknowledgements

 * Mehdi Hasan Khan, for originally developing and maintaining Avro Keyboard.

 * Rifat Nabi, for porting Avro Phonetic to Javascript.

 * https://github.com/sarim[Sarim Khan], for writing ibus-avro.

 * https://github.com/saaiful[Saiful Islam], for the icon.

 * https://material.io/resources/icons[Material Design Icons].

 * https://github.com/alex-spataru/QSimpleUpdater[QSimpleUpdater], for providing update mechanism.



== License

This project is licensed under https://opensource.org/licenses/GPL-3.0[GPL 3 Licence].



Made with ❤️ by https://github.com/mominul[Muhammad Mominul Huque] and https://github.com/OpenBangla/OpenBangla-Keyboard/graphs/contributors[✨ contributors ✨]!