Skip to content

Commit b565977

Browse files
committed
(hopefully) fixed gitattributes, added official dutch version, clearer readme
1 parent ecbffc0 commit b565977

File tree

3 files changed

+575
-6
lines changed

3 files changed

+575
-6
lines changed

.gitattributes

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,13 @@ pkl/pkl.ini linguist-language=INI
55
pkl/layouts/us-refor linguist-language=INI
66
xkb/XCompose linguist-language=XCompose
77
xkb/symbols/us-refor linguist-language=C
8-
xkb/types/us-refor linguist-language=C
8+
xkb/types/us-refor linguist-language=C
9+
10+
us-refor.json linguist-detectable
11+
keylayout/usrefor.keylayout linguist-detectable
12+
klc/us-refor.klc linguist-detectable
13+
pkl/pkl.ini linguist-detectable
14+
pkl/layouts/us-refor linguist-detectable
15+
xkb/XCompose linguist-detectable
16+
xkb/symbols/us-refor linguist-detectable
17+
xkb/types/us-refor linguist-detectable

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@
2222
- [Credits](#credits)
2323

2424
## The Problem
25-
I originally made this layout because included Windows keyboard layout for United States (International) is subpar. Here is a list of things the Windows US-International layout does not have that are usually included in layouts such as the one included on Linux:
25+
I originally made this layout because included Windows keyboard layout for United States (International) is subpar. Here is a list of things the Windows US-International layout does not have that are usually included in layouts such as the one included in X on Linux:
2626
* The `œ` ligature
2727
* Left and right facing quotation marks `` ``
2828
* The breve, caron, double acute, ogonek, macron, overdot, underdot, and overring diacritical marks
29-
* The lack of the option for dead keys activated by `AltGr`, which means that single symbols that are also used as diacritical marks such as the `'` must be followed by a space
29+
* The lack of the option for dead keys activated by `AltGr`, which means that single symbols that are also used as diacritical marks such as the `'` must be typed with a following `Space`
3030

3131
There was a very noble attempt to fix this madness by fellow GitHub user [thomasfaingnaert](https://github.com/thomasfaingnaert/win-us-intl-altgr). However, it only addresses the last problem, does not contain a copyleft-friendly license, and does not map a large number of precomposed letters with diacritics in Unicode.
3232

3333
But upon looking at the way US-International tends to be done, I realized some of its inefficiencies and nonsensical mappings.
3434
### Therefore, I decided to reform the entire layout. And due to the changes I made, I also decided to make this layout cross-platform!
3535

3636
## The Standard
37-
This is the way that US-International is usually done in Linux and such, and will be compared against below:
37+
This is the way that US-International is usually done in the Linux sphere and such, and will be compared against below:
3838
![US-International](https://wildcard.yiff.church/i/im1h033s.png)
3939
## The Reform
4040
![US-Reformed-International](https://wildcard.yiff.church/i/1lksz7b8.png)
@@ -109,10 +109,19 @@ Here is a (imperfect) list of languages and dialects using the Latin alphabet. T
109109
## Windows
110110
Pick **one** (1) of the install methods below
111111
### KLC (**Recommended**, no 3rd party software required)
112-
Download the latest `klc.zip` from [the releases tab of this repo](https://github.com/barkloaf/US-Reformed-International/releases). Extract it and run `Setup.exe` from the folder.
112+
**United States**: Download the latest `klc.zip` from [the releases tab of this repo](https://github.com/barkloaf/US-Reformed-International/releases). Extract it and run `Setup.exe` from the resulting folder.
113113
To apply the layout, go to Windows settings > `Time & Language` > `Language` > `English (United States)` > `Options` > `Add a keyboard` > `United States (Reformed International)`
114114

115-
Alternatively, you may download the source code file `klc/us-refor.klc` and open it in [Microsoft Keyboard Layout Creator](https://www.microsoft.com/en-us/download/details.aspx?id=22339). An installer is created by going to `Project`>`Build DLL and Setup Package`. Run `Setup.exe` from the resulting folder.
115+
**Netherlands:** If you wish to install the layout to the `nl-NL` locale, download the latest `klc-nl.zip` from [the releases tab of this repo](https://github.com/barkloaf/US-Reformed-International/releases). Extract it and run `Setup.exe` from the resulting folder. To apply the layout, go to Windows settings > `Tijd en Taal` > `Taal` > `Nederlands (Nederland)` > `Opties` > `Een toetsenbord toevoegen` > `Verenigde Staten (gewijzigd internationaal)`
116+
117+
**Other locales:** `klc.zip` installs to the `en-US` locale. If you wish to install the layout to a different locale:
118+
1. Download the source code file [`klc/us-refor.klc`](https://github.com/barkloaf/US-Reformed-International/blob/master/klc/us-refor.klc)
119+
2. Open the file you just modified in [Microsoft Keyboard Layout Creator](https://www.microsoft.com/en-us/download/details.aspx?id=102134)
120+
3. Edit the language in `Project` > `Properties...` > `Language`
121+
* **Note:** MSKLC will not compile the layout if it shares a name with an existing keyboard on your system. The name of the layout can also be changed in this menu if necessary.
122+
4. Create the installer by going to `Project` > `Build DLL and Setup Package`
123+
5. Run `Setup.exe` from the resulting folder.
124+
6. Apply the layout in Windows settings > `Time & Language` > `Language` > (Language name) > `Options` > `Add a keyboard` > `United States (Reformed International)`
116125

117126
### AutoHotkey
118127
Presuming [AutoHotkey](https://www.autohotkey.com) is installed, download the latest `ahk.zip` from [the releases tab of this repo](https://github.com/barkloaf/US-Reformed-International/releases). Extract it and run `us-refor.ahk` from the folder.

0 commit comments

Comments
 (0)