You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

63 lines
4.4 KiB

  1. # Как использовать GitHub с QMK
  2. GitHub может показаться несколько сложным для тех, кто никогда с ним не работал. В данном руководстве будет разобран каждый шаг создания форка, клонирования и отправки пулреквеста в QMK.
  3. ?> В этом руководстве предполагается, что вы в какой-то степени знакомы с работой в командной строке, и в вашей системе установлен git.
  4. Откройте [страницу QMK на GitHub] (https://github.com/qmk/qmk_firmware), и в правом верхнем углу вы увидите кнопку с надписью "Fork":
  5. ![Fork on GitHub](https://i.imgur.com/8Toomz4.jpg)
  6. Если вы состоите в какой-либо организации, вам нужно выбрать учетную запись, к которой будет привязан форк. В большинстве случаев это будет личной аккаунт. Как только ваш форк будет завершен (иногда это занимает немного времени), нажмите кнопку "Clone or Download":
  7. ![Download from GitHub](https://i.imgur.com/N1NYcSz.jpg)
  8. И обязательно выберите "HTTPS", затем выделите ссылку и скопируйте ее:
  9. ![HTTPS link](https://i.imgur.com/eGO0ohO.jpg)
  10. Теперь введите `git clone --recurse-submodules ` в командную строку, а затем вставьте ссылку:
  11. ```
  12. user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git
  13. Cloning into 'qmk_firmware'...
  14. remote: Enumerating objects: 9, done.
  15. remote: Counting objects: 100% (9/9), done.
  16. remote: Compressing objects: 100% (5/5), done.
  17. remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874
  18. Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done.
  19. Resolving deltas: 100% (119972/119972), done.
  20. ...
  21. Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b'
  22. Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486'
  23. Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780'
  24. Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d'
  25. ```
  26. Теперь у вас есть форк QMK на вашем локальном компьютере, и вы можете добавить свою раскладку, скомпилировать ее и прошить ей свою клавиатуру. Как только вы будете довольны своими изменениями, есть возможность добавить, зафиксировать их и сделать коммит в свой форк следующим образом:
  27. ```
  28. user@computer:~$ git add .
  29. user@computer:~$ git commit -m "adding my keymap"
  30. [master cccb1608] adding my keymap
  31. 1 file changed, 1 insertion(+)
  32. create mode 100644 keyboards/planck/keymaps/mine/keymap.c
  33. user@computer:~$ git push
  34. Counting objects: 1, done.
  35. Delta compression using up to 4 threads.
  36. Compressing objects: 100% (1/1), done.
  37. Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
  38. Total 1 (delta 1), reused 0 (delta 0)
  39. remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
  40. To https://github.com/whoeveryouare/qmk_firmware.git
  41. + 20043e64...7da94ac5 master -> master
  42. ```
  43. Ваши изменения теперь существуют в вашем форке на GitHub - если вернуться туда (`https://github.com/<whoeveryouare>/qmk_firmware`), вы сможете создать "New Pull Request" нажатием на кнопку:
  44. ![New Pull Request](https://i.imgur.com/DxMHpJ8.jpg)
  45. Здесь вы сможете увидеть, какие именно изменения были внесены, - если все выглядит хорошо, вы можете завершить его, нажав "Create Pull Request":
  46. ![Create Pull Request](https://i.imgur.com/Ojydlaj.jpg)
  47. После отправки мы можем расспросить вас о ваших изменениях, попросить внести корректировки и в конечном итоге принять их! Спасибо за ваш вклад в QMK :)