Skip to content

Commit 0b449d7

Browse files
authored
wip: revise README for clarity and accuracy
updated the README to enhance clarity and correctness.
1 parent bdb186e commit 0b449d7

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,63 @@
11
# OpenBangla Keyboard (OBK)
22

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).
44

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

77
## Installation
88

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**
1017

1118
```sh
1219
curl -fsSL https://openbangla.github.io/install | bash
1320
```
1421

15-
For Windows
22+
**Windows (PowerShell)**
1623

1724
```powershell
18-
irm openbangla.github.io/install.ps1 | iex
25+
irm "https://openbangla.github.io/install.ps1" | iex
1926
```
2027

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+
2132
## Community
2233

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).
2435

2536
## Contributing
2637

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:
2841

2942
1. Fork the repository.
3043
2. Create a new branch (`git checkout -b feature-branch`).
3144
3. Commit your changes (`git commit -m 'Add new feature'`).
3245
4. Push to the branch (`git push origin feature-branch`).
3346
5. Open a Pull Request.
3447

48+
If you find a bug or have a feature request, please [open an issue](https://github.com/OpenBangla/OpenBangla-Keyboard/issues).
49+
3550
## Acknowledgements
3651

3752
- [Mehdi Hasan Khan](https://github.com/mugli), for originally developing and maintaining Avro Keyboard.
3853
- [Rifat Nabi](https://github.com/torifat), for porting Avro Phonetic to Javascript.
3954
- [Sarim Khan](https://github.com/sarim), for writing ibus-avro.
4055
- [Saiful Islam](https://github.com/saaiful), for the icon.
4156
- [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.
4358

4459
## License
4560

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).
4762

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

0 commit comments

Comments
 (0)