From 47d4105dbb1267b4c4b25ca16d4888166020257f Mon Sep 17 00:00:00 2001 From: bdeshi Date: Thu, 22 Aug 2024 03:26:49 +0600 Subject: [PATCH] readme: add Usage section, minor touchups --- README.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a51f30f..45eb0c4 100644 --- a/README.md +++ b/README.md @@ -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] [🏛][w] with two variations: +This is faithful to the scheme published at [ekushey.org][e] [🏛][w] with two variations: - **Probhat (BD)**: BDT symbol (৳) on SHIFT+4 - **Probhat (IN)**: INR symbol (₹) on SHIFT+4 @@ -15,38 +13,47 @@ It is faithful to the scheme published at [ekushey.org][e] [🏛][w] 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).
## The Keyboard Layout ![graphical view of the layout](./probhat-layout-apple-wireless.png) -(image generated with https://keyboard-layout-editor.com) +image generated with https://keyboard-layout-editor.com [e]: https://www.ekushey.org/?page/probhat_layout [w]: https://web.archive.org/web/20200815053905/https://ekushey.org/?page/probhat_layout