Skip to content

Commit 64b0033

Browse files
committed
docs: Clarify steps for vial repository
1 parent 09c8ff7 commit 64b0033

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ If the keyboard has not been merged yet to the main branch of QMK you may need t
88

99
## Howto configure your build targets
1010

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.
1213
1. Fork this repository
1314
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).
1415
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
4041

4142
## Howto build locally
4243

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.
4446
1. Fork this repository
4547
1. Clone your fork to your local machine
4648
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
5860
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:
5961
```
6062
with:
61-
qmk_repo: qmk/qmk_firmware
62-
qmk_ref: master
63+
qmk_repo: vial-kb/vial-qmk
64+
qmk_ref: vial
6365
```
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`
71-
1. (To update) `git submodule update --init --recursive`
72-
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.
7367

7468

7569
## Adding splitkb fork to an existing fork

0 commit comments

Comments
 (0)