|
1 | 1 | # OpenBangla Keyboard (OBK) |
2 | 2 |
|
3 | | -OpenBangla Keyboard is an open-source, Unicode-compliant Bangla input method for GNU/Linux, macOS, and Windows. As a comprehensive typing solution, it features advanced automation tools and supports popular layouts including Avro Phonetic, Probhat, Munir Optima, and National (Jatiya). |
| 3 | +OpenBangla Keyboard is an open-source, Unicode-compliant Bangla input method built with Rust and C++ for GNU/Linux, macOS, and Windows. As an incredibly fast, high-performance, cross-platform solution, it features advanced automation tools and supports popular layouts such as Avro Phonetic, Probhat, Munir Optima, and National (Jatiya). |
4 | 4 |
|
5 | | -Most features of [Avro Keyboard](https://github.com/mugli/Avro-Keyboard) are present in OpenBangla Keyboard. So Avro Keyboard users will feel right at home in Linux with OpenBangla Keyboard. |
| 5 | +Most features of [Avro Keyboard](https://github.com/mugli/Avro-Keyboard) are included here. This makes OBK familiar and intuitive for longtime Avro Keyboard users. |
6 | 6 |
|
7 | 7 | ## Installation |
8 | 8 |
|
9 | | -For GNU/Linux and macOS |
| 9 | +> [!IMPORTANT] |
| 10 | +> If you have OpenBangla Keyboard 2.0.0 or an earlier version installed, please [uninstall](https://openbangla.github.io/manual#uninstall) it first. |
| 11 | +
|
| 12 | +### Quick Start |
| 13 | + |
| 14 | +Choose the command below based on your operating system to install the latest version automatically. |
| 15 | + |
| 16 | +**GNU/Linux and macOS** |
10 | 17 |
|
11 | 18 | ```sh |
12 | 19 | curl -fsSL https://openbangla.github.io/install | bash |
13 | 20 | ``` |
14 | 21 |
|
15 | | -For Windows |
| 22 | +**Windows (PowerShell)** |
16 | 23 |
|
17 | 24 | ```powershell |
18 | | -irm openbangla.github.io/install.ps1 | iex |
| 25 | +irm "https://openbangla.github.io/install.ps1" | iex |
19 | 26 | ``` |
20 | 27 |
|
| 28 | +### Manual Installation |
| 29 | + |
| 30 | +For advanced users who prefer to build from source or manually configure environment variables, please refer to our [Manual](https://openbangla.github.io/manual#installation). Alternatively, you can download installers for your operating system (e.g., `.exe` `.deb`), from our [releases](https://github.com/OpenBangla/OpenBangla-Keyboard/releases). |
| 31 | + |
21 | 32 | ## Community |
22 | 33 |
|
23 | | -We are on [Github Discussions](https://github.com/OpenBangla/OpenBangla-Keyboard/discussions) and [Facebook](https://www.facebook.com/openbanglakeyboard). |
| 34 | +We are on [GitHub Discussions](https://github.com/OpenBangla/OpenBangla-Keyboard/discussions) and [Facebook](https://www.facebook.com/openbanglakeyboard). |
24 | 35 |
|
25 | 36 | ## Contributing |
26 | 37 |
|
27 | | -We welcome contributions! To get started: |
| 38 | +We welcome contributions! Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for full details on our contribution process. |
| 39 | + |
| 40 | +To get started quickly: |
28 | 41 |
|
29 | 42 | 1. Fork the repository. |
30 | 43 | 2. Create a new branch (`git checkout -b feature-branch`). |
31 | 44 | 3. Commit your changes (`git commit -m 'Add new feature'`). |
32 | 45 | 4. Push to the branch (`git push origin feature-branch`). |
33 | 46 | 5. Open a Pull Request. |
34 | 47 |
|
| 48 | +If you find a bug or have a feature request, please [open an issue](https://github.com/OpenBangla/OpenBangla-Keyboard/issues). |
| 49 | + |
35 | 50 | ## Acknowledgements |
36 | 51 |
|
37 | 52 | - [Mehdi Hasan Khan](https://github.com/mugli), for originally developing and maintaining Avro Keyboard. |
38 | 53 | - [Rifat Nabi](https://github.com/torifat), for porting Avro Phonetic to Javascript. |
39 | 54 | - [Sarim Khan](https://github.com/sarim), for writing ibus-avro. |
40 | 55 | - [Saiful Islam](https://github.com/saaiful), for the icon. |
41 | 56 | - [Material Design Icons](https://material.io/resources/icons). |
42 | | -- [QSimpleUpdater](https://github.com/alex-spataru/QSimpleUpdater), for providing update mechanism. |
| 57 | +- [QSimpleUpdater](https://github.com/alex-spataru/QSimpleUpdater), for providing the update mechanism. |
43 | 58 |
|
44 | 59 | ## License |
45 | 60 |
|
46 | | -This project is licensed under [GPL 3 Licence](https://opensource.org/licenses/GPL-3.0). |
| 61 | +This project is licensed under [GPL 3 License](https://opensource.org/licenses/GPL-3.0). |
47 | 62 |
|
48 | 63 | Made with ❤️ by [Muhammad Mominul Huque](https://github.com/mominul) and [✨ contributors ✨](https://github.com/OpenBangla/OpenBangla-Keyboard/graphs/contributors)! |
0 commit comments