diff --git a/.gitignore b/.gitignore index 364fdec..fa9c5eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ public/ +node_modules/ diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 6bfc20a..470c24d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -7,11 +7,10 @@ workflow: before_script: - cat /etc/os-release - yarn --version - - yarn add bulma - - yarn list pages: script: + - make deps - make build artifacts: paths: diff --git a/Makefile b/Makefile index aa884c8..8d77813 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,8 @@ build: clean mkdir -p public/{css,js,img} cp node_modules/bulma/css/bulma.min.css public/css/ + cp node_modules/@fortawesome/fontawesome-free/css/all.min.css public/css/fontawesome.min.css + cp -r node_modules/@fortawesome/fontawesome-free/webfonts public/ cp -r css public/ cp -r js public/ cp -r img public/ @@ -10,7 +12,7 @@ clean: rm -rf public deps: - yarn add bulma + yarn serve: cd public ; python -m http.server diff --git a/index.html b/index.html index ba99986..f01d71c 100644 --- a/index.html +++ b/index.html @@ -6,10 +6,210 @@ mkbd65 - by XenGi + + + +
+
+
+

+ mkbd65 +

+

+ Mobile 65% keyboard addon for modern smartphones +

+
+
+
+ +
+
+

Features

+ +
+
    +
  • Full qwerty keyboard layout (us-altgr-intl)
    • +
  • Fully customizable
    • +
  • Uses USB-C
    • +
  • Open source firmware
    • +
  • Open hardware
    • +
+
+
+
+ +
+
+

Planned features

+ +
+
    +
  • + Integrated USB 3 Hub +
      +
    • Additional USB-C port
      • +
    • USB-PD passthrough
      • +
    +
    • +
  • Headphone jack
    • +
  • Key Frontlight
    • +
+
+
+
+ +
+
+

Layout

+ + 
0: no mod
+╔════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦═════════╗
+║ ESC║ 1  ║ 2  ║ 3  ║ 4  ║ 5  ║ 6  ║ 7  ║ 8  ║ 9  ║ 0  ║BACKSPACE║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╦════╣
+║ q  ║ w  ║ e  ║ r  ║ t  ║ y  ║ u  ║ i  ║ o  ║ p  ║ [  ║ ]  ║ \  ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╩════╣
+║ a  ║ s  ║ d  ║ f  ║ g  ║ h  ║ j  ║ k  ║ l  ║ ;  ║ '  ║ RETURN  ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬═════════╣
+║ z  ║ x  ║ c  ║ v  ║ b  ║ n  ║ m  ║ ,  ║ .  ║ /  ║ ▲  ║ SHIFT   ║
+╠════╬════╬════╬════╬════╩════╩════╬════╬════╬════╬════╬════╦════╣
+║CTRL║ FN ║SHFT║ALTG║     SPACE    ║ -  ║ =  ║ ◀  ║ ▼  ║ ▶  ║CTRL║
+╚════╩════╩════╩════╩══════════════╩════╩════╩════╩════╩════╩════╝
+
+ 
1: mod shift (default keyboard behaviour)
+╔════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦═════════╗
+║ ESC║ !  ║ @  ║ #  ║ $  ║ %  ║ ^  ║ &  ║ *  ║ (  ║ )  ║BACKSPACE║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╦════╣
+║ Q  ║ W  ║ E  ║ R  ║ T  ║ Y  ║ U  ║ I  ║ O  ║ P  ║ {  ║ }  ║ |  ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╩════╣
+║ A  ║ S  ║ D  ║ F  ║ G  ║ H  ║ J  ║ K  ║ L  ║ :  ║ "  ║ RETURN  ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬═════════╣
+║ Z  ║ X  ║ C  ║ V  ║ B  ║ N  ║ M  ║ <  ║ >  ║ ?  ║ ▲  ║░░░░░░░░░║
+╠════╬════╬════╬════╬════╩════╩════╬════╬════╬════╬════╬════╦════╣
+║CTRL║ FN ║░░░░║ALTG║     SPACE    ║ _  ║ +  ║ ◀  ║ ▼  ║ ▶  ║CTRL║
+╚════╩════╩════╩════╩══════════════╩════╩════╩════╩════╩════╩════╝
+
+ 
2: mod altgr (default keyboard behaviour)
+╔════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦═════════╗
+║    ║ ¹  ║ ²  ║ ³  ║ ¤  ║ €  ║ ^  ║ ̛   ║ ˛  ║ ‘  ║ ’  ║BACKSPACE║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╦════╣
+║ ä  ║ å  ║ é  ║ ë  ║ þ  ║ ü  ║ ú  ║ í  ║ ó  ║ ö  ║ «  ║ »  ║ ¬  ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╩════╣
+║ á  ║ ß  ║ ð  ║    ║    ║    ║ ï  ║ œ  ║ ø  ║ ¶  ║ ´  ║ RETURN  ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬═════════╣
+║ æ  ║ œ  ║ ©  ║ ®  ║    ║ ñ  ║ µ  ║ ç  ║ ˙  ║ ¿  ║ ▲  ║ SHIFT   ║
+╠════╬════╬════╬════╬════╩════╩════╬════╬════╬════╬════╬════╦════╣
+║CTRL║ FN ║SHFT║░░░░║     SPACE    ║ ¥  ║ ×  ║ ◀  ║ ▼  ║ ▶  ║CTRL║
+╚════╩════╩════╩════╩══════════════╩════╩════╩════╩════╩════╩════╝
+
+ 
3: mod fn (adds missing keys)
+╔════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦════╦═════════╗
+║ Esc║ F1 ║ F2 ║ F3 ║ F4 ║ F5 ║ F6 ║ F7 ║ F8 ║ F9 ║ F10║ DELETE  ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╦════╣
+║    ║    ║    ║    ║    ║    ║    ║    ║    ║    ║ F11║ F12║    ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╩════╣
+║    ║    ║    ║    ║    ║    ║    ║    ║    ║    ║ `  ║ Super   ║
+╠════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬════╬═════════╣
+║    ║    ║    ║    ║    ║    ║    ║    ║    ║    ║PgUp║ SHIFT   ║
+╠════╬════╬════╬════╬════╩════╩════╬════╬════╬════╬════╬════╦════╣
+║SUPR║░░░░║SHFT║ALTG║     Tab      ║    ║    ║Pos1║PgDn║ End║CTRL║
+╚════╩════╩════╩════╩══════════════╩════╩════╩════╩════╩════╩════╝
+
+
+
+ +
+
+

Tips

+ +
+
    +
  • Hold left thumb on Ctrl and Fn to press Super
    • +
  • Get ` key by pressing Fn with left thumb and ' with right thumb
    • +
  • Get ~ key by pressing Fn+Shift with left thumb and ' with right thumb
    • +
  • Since Android doesn't really use the Alt key, the Alt key n this keyboar is actually an AltGr key to give you the € and umlauts
    • +
  • + Sorry france :( +
      +
    • Pressing AltGr+Fn+' is the only way to get ` and combine it with the next char
      • +
    • Pressing AltGr+Shift+Fn+' is the only way to get ~ and combine it with the next char
      • +
    +
    • +
+
+
+
+ +
+

+ USB PID +

+
+ +
+
+ +
+
+

Compatible phones

+ +
+
    +
  • Oneplus 8T (planned)
    • +
+
+
+
+ + + diff --git a/package.json b/package.json new file mode 100644 index 0000000..6ae90a7 --- /dev/null +++ b/package.json @@ -0,0 +1,6 @@ +{ + "dependencies": { + "@fortawesome/fontawesome-free": "^5.15.4", + "bulma": "^0.9.3" + } +} diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000..02bf2d5 --- /dev/null +++ b/yarn.lock @@ -0,0 +1,13 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@fortawesome/fontawesome-free@^5.15.4": + version "5.15.4" + resolved "https://registry.yarnpkg.com/@fortawesome/fontawesome-free/-/fontawesome-free-5.15.4.tgz#ecda5712b61ac852c760d8b3c79c96adca5554e5" + integrity sha512-eYm8vijH/hpzr/6/1CJ/V/Eb1xQFW2nnUKArb3z+yUWv7HTwj6M7SP957oMjfZjAHU6qpoNc2wQvIxBLWYa/Jg== + +bulma@^0.9.3: + version "0.9.3" + resolved "https://registry.yarnpkg.com/bulma/-/bulma-0.9.3.tgz#ddccb7436ebe3e21bf47afe01d3c43a296b70243" + integrity sha512-0d7GNW1PY4ud8TWxdNcP6Cc8Bu7MxcntD/RRLGWuiw/s0a9P+XlH/6QoOIrmbj6o8WWJzJYhytiu9nFjTszk1g==