From dfbe5a08356c6b0007b13662ca2fa16b0efd195d Mon Sep 17 00:00:00 2001 From: mappu Date: Fri, 7 Feb 2025 18:01:45 +1300 Subject: [PATCH] rcc, uic: add the -Help output to package README.md files --- cmd/miqt-rcc/README.md | 24 ++++++++++++++++++++++++ cmd/miqt-uic/README.md | 16 +++++++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 cmd/miqt-rcc/README.md diff --git a/cmd/miqt-rcc/README.md b/cmd/miqt-rcc/README.md new file mode 100644 index 00000000..b11cdc87 --- /dev/null +++ b/cmd/miqt-rcc/README.md @@ -0,0 +1,24 @@ +# miqt-rcc + +The miqt-rcc program generates the necessary wrappers to use a Qt Designer `.qrc` +resource pack in MIQT `.go` files. + +## Usage + +``` +Usage of ./miqt-rcc: + -Input string + Path to .qrc input file + -OutputGo string + (Optional) Path to .go output file. If omitted, interred from the input file path + -OutputRcc string + (Optional) Path to .rcc output file. If omitted, inferred from the output Go file path + -Package string + Package to use in generated Go files (default "main") + -Qt6 + Use Qt 6 instead of Qt 5 + -RccBinary string + (Optional) Custom path to the Qt rcc program (default "rcc") + -VariableName string + Temporary global variable name for loading embedded data (default "_resourceRcc") +``` diff --git a/cmd/miqt-uic/README.md b/cmd/miqt-uic/README.md index 5a80143d..427de7a3 100644 --- a/cmd/miqt-uic/README.md +++ b/cmd/miqt-uic/README.md @@ -2,7 +2,21 @@ The miqt-uic program compiles Qt Designer `.ui` files into MIQT `.go` files. -For usage information, see the `examples/uidesigner` folder. +## Usage + +For example usage information, see the `examples/uidesigner` folder. + +``` +Usage of ./miqt-uic: + -InFile string + Input .ui file + -OutFile string + Output .go file, or - for stdout (default "-") + -Package string + Custom package name (default "main") + -Qt6 + Use Qt 6 instead of Qt 5 +``` ## Architecture design