Skip to content

Commit

Permalink
doc for on demand build with GitHub Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
koron committed Apr 9, 2024
1 parent 6666b60 commit 5bb94e9
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion qmk_firmware/keyboards/keyball/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,19 @@ There are three keymaps provided at least:

## How to create your keymap

(TO BE DOCUMENTED)
1. Fork this Yowkees/keyball repository
2. Checkout forked repository
3. (OPTIONAL) Create a new branch
4. Add a your keymap, or make some changes
5. Commit changes and push it to your forked repository
6. Open your forked repository with web browser
7. Click and open "Actions" tab
8. Click "Build a firmware on demand" in Workflows on left panel
9. Press "Run workflow" button on right side, then you will see forms
10. (OPTIONAL) Select a your working branch
11. Select a "Keyboard" from drop-down list
12. Enter the "keymap" you want to build
13. Click "Run workflow"
14. Wait a minute until the firmware build is finished
15. Click a latest workflow run and open details
16. Download built firmware in "Artifacts" section

0 comments on commit 5bb94e9

Please sign in to comment.