You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-13Lines changed: 7 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,8 @@ If the keyboard has not been merged yet to the main branch of QMK you may need t
8
8
9
9
## Howto configure your build targets
10
10
11
-
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
11
+
1. Clone the Vial repo: `git clone --recursive https://github.com/vial-kb/vial-qmk`
12
+
1. Run the `qmk setup -H vial-qmk` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
12
13
1. Fork this repository
13
14
1. If you have already forked the `qmk/qmk_userspace` repository before you can add this repository manually following the [steps below](#adding-splitkb-fork-to-an-existing-fork).
14
15
1. Clone your fork to your local machine
@@ -40,7 +41,8 @@ If the keyboard has not been merged yet to the main branch of QMK you may need t
40
41
41
42
## Howto build locally
42
43
43
-
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
44
+
1. Clone the Vial repo: `git clone --recursive https://github.com/vial-kb/vial-qmk`
45
+
1. Run the `qmk setup -H vial-qmk` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
44
46
1. Fork this repository
45
47
1. Clone your fork to your local machine
46
48
1.`cd` into this repository's clone directory
@@ -58,18 +60,10 @@ If you wish to point GitHub actions to a different repository, a different branc
58
60
To override the `build` job, you can change the following parameters to use a different QMK repository or branch, this can be useful if you want to use a the main QMK repository or a different vial branch. For example:
59
61
```
60
62
with:
61
-
qmk_repo: qmk/qmk_firmware
62
-
qmk_ref: master
63
+
qmk_repo: vial-kb/vial-qmk
64
+
qmk_ref: vial
63
65
```
64
-
Our halcyon module code should work fine with the main QMK repository but it may break if there are any breaking changes from QMK in the future. We will try our best to keep this repository up-to-date.
65
-
66
-
If you wish to manually manage `qmk_firmware` using git within the userspace repository, you can add `qmk_firmware` as a submodule in the userspace directory instead. GitHub Actions will automatically use the submodule at the pinned revision if it exists, otherwise it will use the default latest revision of `qmk_firmware` from the main repository. This will not work when using vial.
67
-
68
-
This can also be used to control which fork is used.
69
-
70
-
1. (First time only) `git submodule add https://github.com/qmk/qmk_firmware.git`
1. Commit your changes to your userspace repository
66
+
Our halcyon module code should work fine with the main QMK repository but it may break if there are any breaking changes from QMK in the future. We will try our best to keep this repository up-to-date. You can track this in the `halcyon-qmk` branch.
0 commit comments