update README, add license

ysoftwareab · Nov 10, 2021 · 97a9d26 · 97a9d26
1 parent 763e016
commit 97a9d26
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,54 @@
-# Mac OSX - PC Keyboard Layouts
+# PC Keyboard Layouts for MacOS (xkb based)
 
-PC-based keyboard layouts for Mac OSX with some customizations. Thanks to [Ukulele](http://scripts.sil.org/ukelele).
+Thanks to [klfc](https://github.com/39aldo39/klfc),
+we converted all keyboard layouts from an Ubuntu 20.04 distribution (X11 xkb) to MacOS (keylayout).
 
+Outcome: type on your Mac the same way you would type on a PC.
 
-# Install
 
-Copy to your `~/Library/Keyboard Layouts` folder, and then activate them via `System Preferences` - `Keyboard` - `Keyboard (tab)` - `Input Sources`.
+## Installation
 
+Copy `y-xkb-<language>.*` to your `~/Library/Keyboard Layouts` folder,
+or `/Library/Keyboard Layouts` to install for all users,
+and then activate the `ysoftwareab xkb <language>`
+via `System Preferences` - `Keyboard` - `Keyboard (tab)` - `Input Sources`.
 
-# What customizations ?
 
-For less talk, just install, and fire up `Keyboard Viewer` from the menu bar (need to activate the viewer first it in `System Preferences` - `Keyboard` - `Keyboard (tab)` - `Show Keyboard & Character viewers...`).
+## But why?
 
-For a longer read, go to http://blog.andreineculau.com/2008/12/30/custom_keyboard_layouts_with_romanian_diacritics#content
-(albeit that page has information about the outdated sibling keyboard layouts for PC).
+The reasons stem from the Swedish keyboard layout on MacOS.
+
+Basic keys for programming are a killer to reach:
+
+* `|` is `Right Option + 7`
+* `\` is `Shift + Right Option + 7`
+* `{` is `Shift + Right Option + 8`
+* `}` is `Shift + Right Option + 9`
+
+Same keys on PC:
+
+* `|` is `Right Option + <`
+* `\` is `Right Option + +`
+* `{` is `Right Option + 7`
+* `}` is `Right Option + 0`
+
+Similar issues surface in other languages as you can see in Related Work.
+
+What is different from other initiatives is that this is not a manual conversion.
+
+
+## Related Work
+
+* https://github.com/PetorSFZ/MacOSX-Improved-Swedish-Keyboard-Layout
+* https://github.com/skrysmanski/windows-pc-keyboard-layout-mac
+* https://github.com/memm74/PC-Tastatur105.keylayout
+* https://github.com/cbaggers/backup-uk-keyboard-layouts-for-macos
+* https://gist.github.com/IvanRublev/2da1c7447d0458989d4654b5c35c22b4
+* https://github.com/fardjad/persian-pc.keylayout
+* https://github.com/kalbason/MacOS-Ukrainian-PC-keyboard-layout
+* https://github.com/zaki/mac-hun-keyboard
+
+
+## License
+
+[UNLICENSE](UNLICENSE)
diff --git a/UNLICENSE b/UNLICENSE
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>