From 25f20c68eca61ec97ab7e6cad18761d016db99e1 Mon Sep 17 00:00:00 2001 From: bdeshi Date: Thu, 22 Aug 2024 02:23:42 +0600 Subject: [PATCH 1/4] readme: preview brew, restructure --- README.md | 68 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 42 insertions(+), 26 deletions(-) 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/ -- 2.45.1 From 1b4064e7482208422c2b5e0bdf7da81f3f347a6e Mon Sep 17 00:00:00 2001 From: bdeshi Date: Thu, 22 Aug 2024 03:03:33 +0600 Subject: [PATCH 2/4] readme: show brew tap command --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dd0f123..a51f30f 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,13 @@ It is faithful to the scheme published at [ekushey.org][e] [🏛][w] Run this command to install: ```bash -brew install --cask probhat-keyboard-layout +brew install --cask bdeshi/taps/probhat-keyboard-layout ``` and this one to uninstall: ```shell -brew uninstall --cask probhat-keyboard-layout +brew uninstall --cask bdeshi/taps/probhat-keyboard-layout ``` ### Manually -- 2.45.1 From 47d4105dbb1267b4c4b25ca16d4888166020257f Mon Sep 17 00:00:00 2001 From: bdeshi Date: Thu, 22 Aug 2024 03:26:49 +0600 Subject: [PATCH 3/4] 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 -- 2.45.1 From cc3ebdf3f07b9eca774f2873d282cf9855d1dc25 Mon Sep 17 00:00:00 2001 From: bdeshi Date: Thu, 22 Aug 2024 03:38:10 +0600 Subject: [PATCH 4/4] =?UTF-8?q?readme:=20=E2=AD=90=20=E2=AD=90?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 45eb0c4..1f9f83a 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ This is faithful to the scheme published at [ekushey.org][e] [🏛][w]SHIFT+4 - **Probhat (IN)**: INR symbol (₹) on SHIFT+4 +⭐ *if this is useful to you, feel free to add a github star, thanks!* ⭐ + ## Install ### With Homebrew -- 2.45.1