Skip to content

Commit 12bc240

Browse files
13r0ckjackpot51
authored andcommitted
Improve layout.py '--help' output
1 parent 7f8445d commit 12bc240

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

layouts.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -357,10 +357,10 @@ def generate_layout_dir(ecdir: str, board: str, is_qmk: bool) -> None:
357357
gen_default_json(f'layouts/{board}/default.json', board, default_keymap, is_qmk)
358358
update_meta_json(f'layouts/{board}/meta.json', has_brightness, has_color, keyboard)
359359

360-
parser = argparse.ArgumentParser()
361-
parser.add_argument("ecdir")
362-
parser.add_argument("board")
363-
parser.add_argument("--qmk", action="store_true")
360+
parser = argparse.ArgumentParser(usage="./layouts.py --qmk ../qmk_firmware system76/launch_heavy_1")
361+
parser.add_argument("ecdir", help='For QMK boards that is the qmk_firmware (github.com/system76/qmk_firmware) directory itself, otherwise use the ec directory (github.com/system76/ec)')
362+
parser.add_argument("board", help='The name of the manufacturer and board name. Example: "system76/launch_2"')
363+
parser.add_argument("--qmk", action="store_true", help="Required if you plan on using a keyboard with QMK firmware.")
364364
args = parser.parse_args()
365365

366366
if args.board == 'all':

0 commit comments

Comments
 (0)