users/edvorakjp/readme.md

   1 # edvorakjp
   2
   3 epaew's Enhanced Dvorak layout for Japanese Programmer
   4
   5 ## Layout overview
   6 This is a sample. You can swap any symbol keys and modifier keys.
   7
   8 - Basic layout (for ansi)
   9 ```
  10   //+----+----+----+----+----+----+----+----+----+----+----+----+----+---------+
  11       `  , !  , @  , #  , $  , %  , ^  , &  , *  , (  , )  , [  , ]  ,  BSPC   ,
  12   //+----+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+-------+
  13       TAB  , '  , ,  , .  , Y  , Q  , F  , G  , R  , W  , P  , /  , =  ,   \   ,
  14   //+------++---++---++---++---++---++---++---++---++---++---++---++---+-------+
  15       CAPS  , A  , O  , E  , I  , U  , D  , T  , N  , S  , M  , -  ,    ENT    ,
  16   //+-------+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-+--+-----------+
  17        LSFT   , :  , X  , C  , V  , Z  , H  , J  , K  , L  , B  ,     RSFT     ,
  18   //+------+--+---++----++---+----+----+----+----+-+--+---++----++------+------+
  19       LCTL , LGUI , LALT ,          SPACE          , RALT , RGUI , MENU , RCTL
  20   //+------+------+------+-------------------------+------+------+------+------+
  21 ```
  22
  23  And you can see [my iris keyboard layout](../../keyboards/iris/keymaps/edvorakjp/keymap.c) for sample implementation, too.
  24
  25 ## for Japanese
  26
  27 - 日本語入力用のキーを追加
  28   - IME 切り替えキー
  29     - 長押しでレイヤー切り替え、短押しでIME切り替え
  30     - macOS(かな/英数)、Windows(Alt+\`)の両方に対応
  31 - Define some custom keys for typing Japanese
  32   - IME switching
  33     - act as LOWER/RAISE when hold, act as IME switching when tapped
  34     - for macOS(かな/英数), for Windows(Alt+\`)
  35
  36 ## for Programmer
  37
  38 - Dvorak 配列をベースに、ショートカットでよく利用される XCV は QWERTY 配列の位置を維持
  39 - 一部にVimユーザ用のキー配置を実施
  40     - HJKL キーを横並びで配置
  41     - Shift押下時と非押下時で、";"キーの挙動を入れ替え
  42       （`config.h` 内で `#define SWAP_SCLN` の宣言が必要です）
  43 - デフォルトレイヤーには、数字キーの代わりに記号 `!@#$%^&*()` を配置
  44
  45 - mainly based on Dvorak layout, but XCV is available in the same position of QWERTY layout
  46 - for Vim users
  47     - HJKL is lining side by side
  48     - swap the ";" key behavior. i.e. send ":" normally and send ";" when you hold shift.
  49       (need `#define SWAP_SCLN` in your `config.h`)
  50 - we can type `!@#$%^&*()` keys without shift keys in base layer
  51
  52 ## License
  53
  54 Copyright 2018 Ryo Maeda epaew.333@gmail.com @epaew
  55
  56 This program is free software: you can redistribute it and/or modify
  57 it under the terms of the GNU General Public License as published by
  58 the Free Software Foundation, either version 2 of the License, or
  59 (at your option) any later version.
  60
  61 This program is distributed in the hope that it will be useful,
  62 but WITHOUT ANY WARRANTY; without even the implied warranty of
  63 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  64 GNU General Public License for more details.
  65
  66 You should have received a copy of the GNU General Public License
  67 along with this program.  If not, see <http://www.gnu.org/licenses/>.