OpenBangla / Openbangla Keyboard

//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: 💡 :note-caption: ℹ️ :important-caption: ❗️ :caution-caption: 🔥 :warning-caption: ⚠️ 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} image:https://img.shields.io/bintray/dt/openbangla/ubuntu/openbangla-keyboard?label=Bintray%20Ubuntu[Bintray Ubuntu repo downloads, link=https://img.shields.io/bintray/dt/openbangla/ubuntu/openbangla-keyboard?label=Bintray%20Ubuntu] {nbsp} image:https://img.shields.io/bintray/dt/openbangla/debian/openbangla-keyboard?label=Bintray%20Debian[Bintray Debian downloads, link=https://img.shields.io/bintray/dt/openbangla/debian/openbangla-keyboard?label=Bintray%20Debian] {nbsp} image:https://img.shields.io/bintray/dt/openbangla/fedora/openbangla-keyboard?label=Bintray%20Fedora[Bintray Fedora downloads, link=https://img.shields.io/bintray/dt/openbangla/fedora/openbangla-keyboard?label=Bintray%20Fedora] {nbsp} image:https://img.shields.io/bintray/dt/openbangla/archlinux/openbangla-keyboard?label=Bintray%20Arch%20Linux[Bintray Arch Linux downloads, link=https://img.shields.io/bintray/dt/openbangla/archlinux/openbangla-keyboard?label=Bintray%20Arch%20Linux] {nbsp} image:https://img.shields.io/discord/436879388362014740.svg[Discord, link=https://discord.gg/HXK7QnJ]

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

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.]

First set up our repositories for your distro, then you can install normally with your package manager.

=== Ubuntu & derivatives Run these commands to set up our repository:

source /etc/os-release
sudo sh -c "wget https://dl.bintray.com/openbangla/i/pub.key -q -O - | apt-key add -"
sudo sh -c "wget https://dl.bintray.com/openbangla/i/ubuntu.conf -q -O - | sed s/@[email protected]/$UBUNTU_CODENAME/ > /etc/apt/sources.list.d/openbangla.list"
sudo apt update
sudo apt install openbangla-keyboard

=== Debian & derivatives Run these commands to set up our repository:

source /etc/os-release
sudo sh -c "wget https://dl.bintray.com/openbangla/i/pub.key -q -O - | apt-key add -"
sudo sh -c "wget https://dl.bintray.com/openbangla/i/debian.conf  -q -O - | sed s/@[email protected]/$VERSION_CODENAME/ > /etc/apt/sources.list.d/openbangla.list"
sudo apt update
sudo apt install openbangla-keyboard

=== Fedora Run these commands to set up our repository:

sudo rpm --import https://dl.bintray.com/openbangla/i/pub.key
sudo sh -c "curl https://dl.bintray.com/openbangla/i/fedora.conf > /etc/yum.repos.d/openbangla.repo"
sudo dnf install openbangla-keyboard

=== Archlinux Run these commands to set up our repository:

sudo sh -c "curl https://dl.bintray.com/openbangla/i/pub.key | pacman-key -a -"
sudo pacman-key --lsign-key "[email protected]"
sudo sh -c "curl https://dl.bintray.com/openbangla/i/archlinux.conf >> /etc/pacman.conf"
sudo pacman -Syy
sudo pacman -S openbangla-keyboard

=== 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://discord.gg/HXK7QnJ[Discord] 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:

sudo apt-get install build-essential rustc cargo cmake libibus-1.0-dev qt5-default libzstd-dev

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

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:

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

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

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:

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

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

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

Then issue the build commands:

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 ✨]!