~talos/threelayout-symbols

41abb3aa72ad06feaf61bec9a51444740c133013 — Jordan Newport 1 year, 5 months ago b73e248
Move README to markdown
1 files changed, 14 insertions(+), 23 deletions(-)

M README.md
M README.md => README.md +14 -23
@@ 6,23 6,18 @@ What is ``3l-symbols``?

``3l-symbols`` could be considered an alternative keyboard layout. It uses the
QWERTY letter keys, but improves coding ergonomics by including the symbol and
cursor layers from `Jack Rosenthal's 3l layout`_. Note that use of the symbols
layer is required, because certain symbol keys are replaced by the modifier keys
that give access to the symbol and cursor layers, so the only way to type those
symbols is with the symbols layer.  

.. _`Jack Rosenthal's 3l layout`: https://github.com/jackrosenthal/threelayout
cursor layers from [Jack Rosenthal's 3l
layout](https://github.com/jackrosenthal/threelayout). Note that use of the
symbols layer is required, because certain symbol keys are replaced by the
modifier keys that give access to the symbol and cursor layers, so the only way
to type those symbols is with the symbols layer.

``3l-symbols`` is currently implemented only for Linux and Windows. I can't
really see wanting to make a Mac version myself, but maybe someone else will.
If you want to try, be warned: the Linux, FreeBSD, and Windows implementations
of ``3l`` (the reference layout for this one) are all under 300 lines, but the
Mac OS X implementation is over 2500--try at your own risk.  Having looked at
the FreeBSD implementation of ``3l``, I don't think this layout is worth
implementing in FreeBSD due to the way shortcomings in its keyboard drivers
hamper its ability to add layers.
It's apparently common to use a tool called "Karabiner Elements" to do this; 3l
has an implementation.

.. image:: docs/layout.jpeg
![Layout image](docs/layout.jpeg)

The Sym layer includes the symbols on the upper right of the keys, while the Cur
layer includes the symbols on the bottom of Q-T and A-G.


@@ 41,14 36,12 @@ Switching to a new keyboard layout is hard. It is difficult enough to switch for
typing regular letters, but in my experience, it is far more difficult to switch
to an alternative layout if you are highly familiar with a set of keybindings,
such as those provided by a text editor such as Vim (my personal experience).
However, the symbols and cursors layers provided by such keyboard
layouts as ``3l`` or `Neo`_ (from which ``3l`` itself derives much of its
versions of these layers) are still highly useful, and are far less difficult to
switch to due to the lower frequency of these characters
However, the symbols and cursors layers provided by such keyboard layouts as
``3l`` or [Neo](https://neo-layout.org/index_en.html) (from which ``3l`` itself
derives much of its versions of these layers) are still highly useful, and are
far less difficult to switch to due to the lower frequency of these characters
and the lack of keybindings involving them.

.. _`Neo`: http://neo-layout.org/index_en.html

This layout is intended to make typing code or other symbol-intensive things
more ergonomic and easier by providing symbols in an easier-to-reach place by
providing a symbols layer. It should not make a big difference to speed in


@@ 71,8 64,7 @@ return to normal when the script exits (in the system tray) or you press both
Installation
------------

Linux
~~~~~
### Linux

Place the ``linux/xkb/symbols/3ls`` file in your system's ``symbols`` directory
[1]_, then either:


@@ 96,8 88,7 @@ To create a console mapping from the ``xkb`` symbols file, you can use the

.. [1] This is typically something like ``/usr/share/X11/xkb/symbols``.

Windows
~~~~~~~
### Windows

Place the AHK script in your "Startup" folder.