U.S. custom keyboard layout README.txt
======================================

About
=====

This is a keyboard layout for Mac computers. It has three main
purposes:

* It provides a compose key. The compose key is mapped to two keys on
  the keyboard: § (on an ISO keyboard), ⇧^F13.

* It allows accessing the option key combos even if the physical
  option key is used for something else (e.g. for a meta key in a
  terminal).

* In capslock state, the keyboard does not produce capslock letters.
  Instead, it enters a deadkey mode reminiscent of (but much more
  powerful than) Apple’s U.S. Extended keyboard layout that allows
  for a more convenient input of special characters.

This keyboard layout has been written by j. 'mach' wust. For more
information, see: http://uscustom.sf.net/


Installation
============

1. Drag "U.S. custom.bundle" to either one of
/Library/Keyboard Layouts/ or ~/Library/Keyboard Layouts/.

2. Log out and log in again to complete the installation (it may work
right away).

3. In the International section of the System Preferences, you can
now select "U.S. custom" for the Input Menu. It is now available from
in the menu bar at the top right margin of the screen.


Requirements
============

This is a Mac keyboard layout. It works only on a Mac.

This keyboard layout works best on a physical ISO keyboard. These are
the ones where the enter key is shaped like a turned capital letter
L. The reason why it works best on an ISO keyboard is that it relies
heavily on the additional key the ISO keyboards provide.


Editing the keyboard layout
===========================

If you wish to edit the keyboard layout, I recommend using
TextWrangler, a powerful free (but not open) text editor of Bare
Bones Software: <http://www.barebones.com/products/textwrangler/>

You may use Ukelele, the free SIL Mac OS X Keyboard Layout Editor,
for viewing the U.S. custom keyboard layout and for pre-validating
any changes you have made. Previous versions of Ukelele would mess up
this keyboard layout.


Versions
========

2015-06-29
    New release, now as a keylayout bundle that will show up as an
    English keyboard layout in System Preferences. Also, numerous
    additional characters.

2012-08-30
    New release, swapped compose (now §) and option deadkey (now ±,
    that is, ⇧+§).

2012-08-28
    New release, with compose key now additionally mapped to ⇧+^+F13.

2012-08-24
    New release, now with a compose key.

2010-08-20
    Initial release.


License
=======

This is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.