Skip to content

Commit

Permalink
Replace readme
Browse files Browse the repository at this point in the history
You can use pipe to shell, but you don't have to.
  • Loading branch information
lwbt committed Jun 21, 2022
1 parent 8ff0990 commit f0825c2
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 39 deletions.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
# osx-us-altgr-intl
# US-AltGr-International Keyboard Layout for macOS

This is an adaptation of the Xorg US keymap "altgr-intl" variant for OSX. More
information can be found
[here](https://lists.x.org/archives/xorg/2007-July/026534.html) and
[here](https://zuttobenkyou.wordpress.com/2011/08/24/xorg-using-the-us-international-altgr-intl-variant-keyboard-layout/).
This is a custom keyboard layout for macOS. On Linux distributions, Chrome OS
and Windows it is typically called US International with dead keys.

# Usage
I modified some illustrative ASCII art I found, which you can find
[here](./docs/ascii_art.md).

```bash
sudo cp "us-altgr-intl.keylayout" "/Library/Keyboard Layouts"
```

A reboot is probably necessary for the new keymap to appear in
Preferences/Keyboard.
## Installation

This has been tested with OSX Mojave 10.14.6.
- TODO: describe GUI
- TODO: describe terminal

# Improvements
```bash
curl -L https://raw.githubusercontent.com/lwbt/osx-us-altgr-intl/master/install.sh | bash
```

Basics are here for my own usage but diacritics combinations (dead-keys mode
overlappings) are probably missing. Any improvement is welcome. This file has
been developped with Ukulele for a US ANSI keyboard.
To my current knowledge you have to reboot or log out of your Mac and back in
again to be able to use it. I think there must be a system service in macOS
which you can trigger to pickup tha changes.
23 changes: 0 additions & 23 deletions README.new.md

This file was deleted.

23 changes: 23 additions & 0 deletions README.old.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# osx-us-altgr-intl

This is an adaptation of the Xorg US keymap "altgr-intl" variant for OSX. More
information can be found
[here](https://lists.x.org/archives/xorg/2007-July/026534.html) and
[here](https://zuttobenkyou.wordpress.com/2011/08/24/xorg-using-the-us-international-altgr-intl-variant-keyboard-layout/).

# Usage

```bash
sudo cp "us-altgr-intl.keylayout" "/Library/Keyboard Layouts"
```

A reboot is probably necessary for the new keymap to appear in
Preferences/Keyboard.

This has been tested with OSX Mojave 10.14.6.

# Improvements

Basics are here for my own usage but diacritics combinations (dead-keys mode
overlappings) are probably missing. Any improvement is welcome. This file has
been developped with Ukulele for a US ANSI keyboard.

0 comments on commit f0825c2

Please sign in to comment.