bdeshi/probhat-mac-osx
bdeshi/probhat-mac-osx
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

readme: preview brew, restructure

Browse Source
This commit is contained in:
bdeshi 2024-08-22 02:23:42 +06:00
parent a2d45d31dd
commit 25f20c68ec
Signed by: bdeshi
GPG Key ID: 410D03DA9A3468E0
1 changed files with 42 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -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] <sup>[🏛][w]</sup> with two variations:
There are two variations:
- **Probhat (BD)**: BDT symbol (৳) on <kbd>SHIFT</kbd>+<kbd>4</kbd>
- **Probhat (IN)**: INR symbol (₹) on <kbd>SHIFT</kbd>+<kbd>4</kbd>
Other than this variation, the layouts are faithful to the scheme published at [ekushey.org][e]<span style="font-size:60%">[🏛][w]</span>
## 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).
<hr>
## The Keyboard Layout
![graphical view of the layout](./probhat-layout-apple-wireless.png)
<sup>(image generated with https://keyboard-layout-editor.com)</sup>
### NOTES
- The <kbd>Control</kbd> and <kbd>Command</kbd> special keys use US QWERTY layouts.
- Some key combinations may conflict with some application-specific shortcuts. For example, <kbd>SHIFT</kbd>+<kbd>ALT</kbd>+<kbd>A</kbd> 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.
<hr>
[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
[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/