Добавил енг ридми
This commit is contained in:
urec56
parent
c05c0245b4
commit
3f044c97e5
4 changed files with 72 additions and 19 deletions
|
|
@ -1,11 +1,11 @@
|
|||
# TBK Mini
|
||||
|
||||
[Сайт](https://bastardkb.com/) и [гитхаб](https://github.com/Bastardkb/) разраба клавиатуры.
|
||||
[Site](https://bastardkb.com/) and [github](https://github.com/Bastardkb/) of the author of this keyboard.
|
||||
|
||||
|
||||
## Сборка и прошивка
|
||||
## Building and flashing
|
||||
|
||||
Для клавиатур на базе микроконтроллера `rp2040` команды для сборки и прошивки выглядят так:
|
||||
For keyboards based on `rp2040` comands for buinding and flashing looks like this:
|
||||
```sh
|
||||
make bastardkb/tbkmini/v2/splinky_3:seoa
|
||||
```
|
||||
|
|
@ -14,24 +14,24 @@ make bastardkb/tbkmini/v2/splinky_3:seoa
|
|||
qmk flash -kb bastardkb/tbkmini/v2/splinky_3 -km seoa
|
||||
```
|
||||
|
||||
Выполнять их следует из корня репозитория виала.
|
||||
You shold use it in the root of the `vial` directory.
|
||||
|
||||
После выполнения `qmk flash` нужно одновременно нажать 2 кнопки на микроконтроллере, либо 2 раза нажать кнопу `update`, если она уже распаяна на плате. Так прошивка будет залита на подключённый микроконтроллер.
|
||||
After using `qmk flash` you shold simultaneously press two buttons on the micro or twise press the `update` button if it was installed on plate already. After that you need to mount the `RPI-RP2`(or like this) device to your system and the firmware will be installed on your keyboard.
|
||||
|
||||
|
||||
## Требования
|
||||
## Requirements
|
||||
|
||||
Эта прошивка занимает `~101.5 kb` так что нужно иметь контроллер с достаточным количеством памяти. Все контроллеры на базе `rp2040` не меньше `2 mb` памяти, так что из них можно взять любой.
|
||||
This firmware takes `~101.5 kb` of disk space so you need to use some micro that haue enough space for it. All cotrollers based on `rp2040` have at least `2 mb` of the disk space so you can use any of it.
|
||||
|
||||
|
||||
## Описание
|
||||
## Description
|
||||
|
||||
Автор оригинальной прошивки - [Buliway](https://github.com/Buliway)
|
||||
The author of the original layout - [Buliway](https://github.com/Buliway)
|
||||
|
||||
В данной прошивке реализована кастомная фонетическая раскладка с большим количеством дополнительных кейкодов с разной функциональностью("умная" точка, капс на слово и тп). Часть "фишек" взята из репозитория [lang_shift](https://github.com/klavarog/lang_shift).
|
||||
Custom phonetic layout with many keycodes with different functionality("smart" dot, caps on one word etc.) were implemented in this firmware. Some "features" were added from [lang_shift](https://github.com/klavarog/lang_shift) repo.
|
||||
|
||||
По дефолту стоит смена языка на капс, но это можно изменить под вашу систему в [config.h](./keymaps/seoa/config.h).
|
||||
By defaul it uses the `caps lock` key to change system language but you can change it like in your system in [config.h](./keymaps/seoa/config.h).
|
||||
|
||||
Подсветка в клавиатуре желательна. Она отвечает за цвет слоя, в котором вы сейчас находитесь.
|
||||
I suggest you to have RGB lightning in your keyboard. So it shows you which layer is active now.
|
||||
|
||||
В [./keymaps/seoa/img/](./keymaps/seoa/img/) лежит актуальная схема раскладки и файл для криты, если будет желание её редактировать 
|
||||
In [./keymaps/seoa/img/](./keymaps/seoa/img/) you can see current layout scheme and file for krita so you can modify it 
|
||||
37
bastardkb/tbkmini/readmeru.md
Normal file
37
bastardkb/tbkmini/readmeru.md
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
# TBK Mini
|
||||
|
||||
[Сайт](https://bastardkb.com/) и [гитхаб](https://github.com/Bastardkb/) разраба клавиатуры.
|
||||
|
||||
|
||||
## Сборка и прошивка
|
||||
|
||||
Для клавиатур на базе микроконтроллера `rp2040` команды для сборки и прошивки выглядят так:
|
||||
```sh
|
||||
make bastardkb/tbkmini/v2/splinky_3:seoa
|
||||
```
|
||||
|
||||
```sh
|
||||
qmk flash -kb bastardkb/tbkmini/v2/splinky_3 -km seoa
|
||||
```
|
||||
|
||||
Выполнять их следует из корня репозитория виала.
|
||||
|
||||
После выполнения `qmk flash` нужно одновременно нажать 2 кнопки на микроконтроллере, либо 2 раза нажать кнопу `update`, если она уже распаяна на плате. Потом надо будет смонтировать `RPI-RP2`(или как-то так называется) девайс в вашу систему и прошивка будет залита на клавиатуру.
|
||||
|
||||
|
||||
## Требования
|
||||
|
||||
Эта прошивка занимает `~101.5 kb` так что нужно иметь контроллер с достаточным количеством памяти. Все контроллеры на базе `rp2040` не меньше `2 mb` памяти, так что из них можно взять любой.
|
||||
|
||||
|
||||
## Описание
|
||||
|
||||
Автор оригинальной прошивки - [Buliway](https://github.com/Buliway)
|
||||
|
||||
В данной прошивке реализована кастомная фонетическая раскладка с большим количеством дополнительных кейкодов с разной функциональностью("умная" точка, капс на слово и тп). Часть "фишек" взята из репозитория [lang_shift](https://github.com/klavarog/lang_shift).
|
||||
|
||||
По дефолту стоит смена языка на капс, но это можно изменить под вашу систему в [config.h](./keymaps/seoa/config.h).
|
||||
|
||||
Подсветка в клавиатуре желательна. Она показывает в каком слое вы сейчас находитесь.
|
||||
|
||||
В [./keymaps/seoa/img/](./keymaps/seoa/img/) лежит актуальная схема раскладки и файл для криты, если будет желание её редактировать 
|
||||
12
readme.md
12
readme.md
|
|
@ -1,16 +1,16 @@
|
|||
# Мои раскладки
|
||||
# My layouts
|
||||
|
||||
Для использования этого репозитория надо склонировать его в директорию `vial_qmk`. Работоспособность прошивки протестирована на коммите `159c0888457e5675c6dc0a881e7c5bd8b54203e7` [виала](https://github.com/vial-kb/vial-qmk/commit/159c0888457e5675c6dc0a881e7c5bd8b54203e7).
|
||||
For using this repo you need to clone it to the `vial_qmk` directory. I tested it on the `159c0888457e5675c6dc0a881e7c5bd8b54203e7` commit of [vial](https://github.com/vial-kb/vial-qmk/commit/159c0888457e5675c6dc0a881e7c5bd8b54203e7).
|
||||
|
||||
На данный момент доступны прошивки для:
|
||||
For now it has firmwares for:
|
||||
- [tbkmini](./bastardkb/tbkmini/readme.md)
|
||||
|
||||
|
||||
## Требования
|
||||
## Requirements
|
||||
|
||||
Для компиляции и прошивки нужны `make` и `qmk`.
|
||||
For compiling the firmware and setting it on your keyboard you need to download the `make` and `qmk` utils.
|
||||
|
||||
Если вы используюте `NixOS`, то достаточно прописать эту команду в корне директории виала
|
||||
If you are using the `NixOS` distro then just run this command in the root of the `vial` directory
|
||||
```sh
|
||||
nix-shell shell.nix --run zsh
|
||||
```
|
||||
|
|
|
|||
16
readmeru.md
Normal file
16
readmeru.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# Мои раскладки
|
||||
|
||||
Для использования этого репозитория надо склонировать его в директорию `vial_qmk`. Работоспособность прошивки протестирована на коммите `159c0888457e5675c6dc0a881e7c5bd8b54203e7` [виала](https://github.com/vial-kb/vial-qmk/commit/159c0888457e5675c6dc0a881e7c5bd8b54203e7).
|
||||
|
||||
На данный момент доступны прошивки для:
|
||||
- [tbkmini](./bastardkb/tbkmini/readmeru.md)
|
||||
|
||||
|
||||
## Требования
|
||||
|
||||
Для компиляции и прошивки нужны `make` и `qmk`.
|
||||
|
||||
Если вы используюте `NixOS`, то достаточно прописать эту команду в корне директории виала
|
||||
```sh
|
||||
nix-shell shell.nix --run zsh
|
||||
```
|
||||
Loading…
Add table
Reference in a new issue