Skip to content

Commit bdb186e

Browse files
committed
wip: start converting README from adoc to md
1 parent 7c19213 commit bdb186e

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# OpenBangla Keyboard (OBK)
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).
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.
6+
7+
## Installation
8+
9+
For GNU/Linux and macOS
10+
11+
```sh
12+
curl -fsSL https://openbangla.github.io/install | bash
13+
```
14+
15+
For Windows
16+
17+
```powershell
18+
irm openbangla.github.io/install.ps1 | iex
19+
```
20+
21+
## Community
22+
23+
We are on [Github Discussions](https://github.com/OpenBangla/OpenBangla-Keyboard/discussions) and [Facebook](https://www.facebook.com/openbanglakeyboard).
24+
25+
## Contributing
26+
27+
We welcome contributions! To get started:
28+
29+
1. Fork the repository.
30+
2. Create a new branch (`git checkout -b feature-branch`).
31+
3. Commit your changes (`git commit -m 'Add new feature'`).
32+
4. Push to the branch (`git push origin feature-branch`).
33+
5. Open a Pull Request.
34+
35+
## Acknowledgements
36+
37+
- [Mehdi Hasan Khan](https://github.com/mugli), for originally developing and maintaining Avro Keyboard.
38+
- [Rifat Nabi](https://github.com/torifat), for porting Avro Phonetic to Javascript.
39+
- [Sarim Khan](https://github.com/sarim), for writing ibus-avro.
40+
- [Saiful Islam](https://github.com/saaiful), for the icon.
41+
- [Material Design Icons](https://material.io/resources/icons).
42+
- [QSimpleUpdater](https://github.com/alex-spataru/QSimpleUpdater), for providing update mechanism.
43+
44+
## License
45+
46+
This project is licensed under [GPL 3 Licence](https://opensource.org/licenses/GPL-3.0).
47+
48+
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)