diff --git a/README.md b/README.md index 1667a05..dd0f123 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,57 @@ -### Probhat Bangla keyboard layout for Mac OSX +# Probhat Keyboard Layout for Mac OSX -This project hosts Probhat keyboard layout configuration for Mac OSX systems. +Probhat is a widely popular keyboard layout for the Bangla (aka Bengali) language. + +This project provides this layout as a Mac OS native keyboard layout bundle. + +It is faithful to the scheme published at [ekushey.org][e] [🏛][w] with two variations: -There are two variations: - **Probhat (BD)**: BDT symbol (৳) on SHIFT+4 - **Probhat (IN)**: INR symbol (₹) on SHIFT+4 -Other than this variation, the layouts are faithful to the scheme published at [ekushey.org][e][🏛][w] +## Install -### INSTALLATION -#### install for current user -Copy [`ProbhatKeyboardLayout.bundle`][p] to `~/Library/Keyboard Layouts/` +### With Homebrew -#### install system-wide -Copy [`ProbhatKeyboardLayout.bundle`][p] to `/Library/Keyboard Layouts/` +Run this command to install: -#### uninstall -Remove `ProbhatKeyboardLayout.bundle` from where ever you'd copied it to. +```bash +brew install --cask probhat-keyboard-layout +``` + +and this one to uninstall: + +```shell +brew uninstall --cask probhat-keyboard-layout +``` + +### Manually + +- Download and open a copy of this project from the [Releases][r] page. +- Copy [`ProbhatKeyboardLayout.bundle`][p] to `~/Library/Keyboard Layouts/` (`~` means your home folder) + +To uninstall, remove `ProbhatKeyboardLayout.bundle` from `~/Library/Keyboard Layouts/`. + +## Issues + +Please report issues or missing features on [github][s1] or [gitea][s2]. + +## Credits + +- The Probhat layout was developed at ankurbangla.org. +- This Mac OSX keyboard layout bundle was generated with [Ukelele][k] (no guitars, sorry). + +
+ +## The Keyboard Layout ![graphical view of the layout](./probhat-layout-apple-wireless.png) (image generated with https://keyboard-layout-editor.com) -### NOTES -- The Control and Command special keys use US QWERTY layouts. -- Some key combinations may conflict with some application-specific shortcuts. For example, SHIFT+ALT+A toggles block comments by default in VSCode. - -### ISSUES -Please [report issues or missing features][s]! - -### CREDITS -The Probhat layout was developed by Ankurbangla.org. -This layout bundle was generated with the help of [Ukelele][k] and no guitars. - -
- [e]: https://www.ekushey.org/?page/probhat_layout [w]: https://web.archive.org/web/20200815053905/https://ekushey.org/?page/probhat_layout +[r]: /bdeshi/probhat-mac-osx/releases [p]: ProbhatKeyboardLayout.bundle -[s]: https://github.com/bdeshi/probhat-mac-osx/issues -[k]: https://software.sil.org/ukelele/ \ No newline at end of file +[s1]: https://github.com/bdeshi/probhat-mac-osx/issues +[s2]: https://git.bdeshi.space/bdeshi/probhat-mac-osx/issues +[k]: https://software.sil.org/ukelele/