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

readme: add Usage section, minor touchups

Browse Source
This commit is contained in:
bdeshi 2024-08-22 03:26:49 +06:00
parent 1b4064e748
commit 47d4105dbb
Signed by: bdeshi
GPG Key ID: 410D03DA9A3468E0
1 changed files with 20 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,10 +1,8 @@
# Probhat Keyboard Layout for Mac OSX
Probhat is a widely popular keyboard layout for the Bangla (aka Bengali) language.
This project provides the Probhat keyboard layout as a Mac OS native bundle. Probhat is one of the most popular keyboard layouts 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:
This is faithful to the scheme published at [ekushey.org][e] <sup>[🏛][w]</sup> with two variations:
- **Probhat (BD)**: BDT symbol (৳) on <kbd>SHIFT</kbd>+<kbd>4</kbd>
- **Probhat (IN)**: INR symbol (₹) on <kbd>SHIFT</kbd>+<kbd>4</kbd>
@ -15,38 +13,47 @@ It is faithful to the scheme published at [ekushey.org][e] <sup>[🏛][w]</sup>
Run this command to install:
```bash
```sh
brew install --cask bdeshi/taps/probhat-keyboard-layout
```
and this one to uninstall:
```shell
```sh
brew uninstall --cask bdeshi/taps/probhat-keyboard-layout
```
### Manually
### Without Homebrew
- 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)
Download and open a **source archive** of this project from the [Releases][r] page, and copy [`ProbhatKeyboardLayout.bundle`][p] to `~/Library/Keyboard Layouts/` (`~` means your home folder).
To uninstall, remove `ProbhatKeyboardLayout.bundle` from `~/Library/Keyboard Layouts/`.
## Usage
*These directions may differ slightly across Mac OS versions.*
Go to **System Settings > Keyboard**, add Probhat (BD) or Probhat (IN) in the **Input Sources** section.
Find or set the keyboard shortcut for cycling layouts in **System Settings > Keyboard > Keyboard Shortcuts > Input Sources**.
Layouts can be cycled from the menu bar as well by enabling the input menu item.
## Issues
Please report issues or missing features on [github][s1] or [gitea][s2].
Please report issues or feature requests 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 Probhat layout was developed by ankurbangla.org.
- This Mac OS native 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>
<sup>image generated with https://keyboard-layout-editor.com</sup>
[e]: https://www.ekushey.org/?page/probhat_layout
[w]: https://web.archive.org/web/20200815053905/https://ekushey.org/?page/probhat_layout