feat: finalization of new UI = help message #1069
Conversation
|
Here are my thoughts based on the help_message() {
#shellcheck disable=SC2016
printf ' _ _
__ _ _ _ _ ___║ ║ ____ _ ___║ ║_
/ _` ║ ║ ║ ║ ║/ __║ ║/ / _` ║/ _ \ __║
( (_║ ║ ║_║ ║ ║ (__║ < (_║ ║ __/ ║_ MIT
\__, ║\__,_║_║\___║_║\ \__, ║\___║\__║ license
║_║ version: %s ║___/ part of QUICKEMU project
QEMU %s --------------------------------------------------
> Quickly create and run optimised Linux, <
> Windows and macOS desktop virtual machines. <
homepage - Not Yet
repository - https://github.com/quickemu-project/quickemu
official GUI - https://github.com/quickemu-project/quickgui
by Wimpy https://github.com/flexiondotorg and contributors
Discord - https://discord.gg/wimpy-s-world-712850672223125565
--------------------------------------------------------------
Basic Usage:
quickget <os> <release> [edition]
quickget alpine latest
Advanced Usage:
quickget <arg> [path] <os> [re] [ed]
quickget -d peppermint latest devuan-xfce
Posible arguments:
--os-info (-oi) <os> : Show info about OS
--show-crede (-sc) <os> : Show OS default credentials
--open-homepage (-oh) <os> : Open OS homepage in default browser
--download-iso (-di) <os> <re> [ed] : Just download ISO
--my-iso (-mi) <os> <ISO path>: Create VM with downloaded ISO*
--version (-v) : Show version and exit
--help (-h) : Show this help message and exit
* To prepare custom VM config (Not supported by quickget) use:
quickget --custom <some name> <path to ISO>
-------------- for developers / testing ----------------------
--show-homepage (-sh) <os> : Show OS homepage URL
--show-iso (-si) <os> <re> [ed] : Show·ISO·download·URL
--test-iso (-ti) <os> <re> [ed] : Test if ISO is available
--show-isos (-ss) <os> : Show all ISOs of OS
--test-isos (-ts) <os> : Test all ISOs of OS
--list-csv (-lc) : Show lists in csv format
--list-json (-lj) : Show lists in json format
--list-supported (-ls) : List all OS, releases and editions
--list-isos (-li) : List all supported ISOs
--list-test (-lt) : Test if all ISOs are available
--------------------------------------------------------------
supported Operating Systems:\n' "$(quickemu --version)" "$(qemu-x86_64 -version | head -1 | cut -d' ' -f3)"
os_support | fold -s -w "$(tput cols)"
exit 0
}General feedbackLess is more 🙂
Arguments
Proposal (not tested for syntax)Here is my mock-up based on the above feedback, which hopefully makes things more clear, and includes revised long-hand and shot-hand arguments. help_message() {
#shellcheck disable=SC2016
printf ' _ _
__ _ _ _ _ ___║ ║ ____ _ ___║ ║_
/ _` ║ ║ ║ ║ ║/ __║ ║/ / _` ║/ _ \ __║
( (_║ ║ ║_║ ║ ║ (__║ < (_║ ║ __/ ║_ MIT
\__, ║\__,_║_║\___║_║\ \__, ║\___║\__║ license
║_║ version: %s ║___/ part of Quickemu project
QEMU %s --------------------------------------------------
> Quickly create and run optimised Linux, <
> Windows and macOS desktop virtual machines. <
Project - https://github.com/quickemu-project/quickemu
Discord - https://wimpysworld.io/discord
--------------------------------------------------------------
Basic Usage:
quickget <os> <release> [edition]
quickget ubuntu 22.04
Advanced Usage:
quickget <arg> [path] <os> [re] [ed]
quickget --download ubuntu 22.04
Arguments:
--info (-i) <os> : Show info about OS
--download (-d) <os> <re> [ed] : Download the ISO only; no VM configuration
--open-homepage (-o) <os> : Open homepage for the OS
--version (-v) : Show version
--help (-h) : Show this help message
------------------- For testing & development ----------------
--check (-c) <os> [re] [ed] : Check download an OS release/edition is available
--check-all (-ca) <os> : Check all downloads for an OS are available
--url (-u) <os> <re> [ed] : Show download URL for an OS release/edition
--url-all (-ua) <os> : Show all download URLs for an OS
--list (-l) : List all supported systems in plain text
--list-csv (-lc) : List all supported systems in csv format
--list-json (-lj) : List all supported systems in json format
--list-urls (-lu) : List all supported systems download URLs
--test-urls (-tu) : Check all downloads for all OSs are available
--------------------------------------------------------------
Supported Operating Systems:\n' "$(quickemu --version)"
os_support | fold -s -w "$(tput cols)"
exit 0
}Code foldingIt should be possible to fold some code, as it looks like:
|
👍
👍
Is that really needed? For what/who may I ask? (quickgui?)
👍
This is needed for me. I just want try run any ISO (~/ or https://) with default linux configuration.
aha I will use short one anyway. But long are nice also, if one isn't familiar with program... OK PS: out of topic: Merged HoloISO changes don't work for me... |
Maybe with optional -l legacy flag for legacy BIOS |
|
Less is more 🙂 👍
Already is but... I think better will be ADD something instead I want all part of info printable separately Less is more 🤣Ps: but we don't have font logos yet, just some logos from neofetch as placeholder meanwhile... getops LABCH - that could satisfy both of usJust don't know how to write that into help message... |
zen0bit
force-pushed
the
feature/final-help-message
branch
from
937bd6e
to
28f1822
Compare
|
zen0bit
force-pushed
the
feature/final-help-message
branch
2 times, most recently
from
e358340
to
7479750
Compare
|
I take silence as approval 😃 Implemented getopts. And all (less) arguments except iso-somewhere But I need write use of info into help message Currently:
Use as first argument with choosed OS after that quickget -12345 ubuntu = shows everything Numbers could be changed to alphabet arguments, but I though that could be nice have that clearly separated... |
zen0bit
force-pushed
the
feature/final-help-message
branch
from
8b489ed
to
685c51b
Compare
|
What about this? |
|
Also thinking about nicer logo. Used one is just first, I suggest 😉 leaving that choice for later... I used: standart.flf To choose some i liked... Any graphic designer here? |
zen0bit
changed the title
Yes,
If Let's not target font logos for this new release, we can put it on the roadmap for a future release. |
so could be easily changed just on both sides (as expected)
That's the plan (Or I pushed icons also here?)
|
zen0bit
force-pushed
the
feature/final-help-message
branch
2 times, most recently
from
5ed99d3
to
1d42e98
Compare
zen0bit
force-pushed
the
feature/final-help-message
branch
from
1d42e98
to
fc13093
Compare
Ditto for me, kind of. Removal of Currently, qqX runs On the other hand, it could mask problems too. The better option might be to remove it, in case we forget why it was there and it get removed later causing unexpected breaks. Providing we get sufficiently long enough a beta/RC time slot I should be able to cope. I generally prefer the new API. I like the idea of being able to directly extract the target URL At the moment things are so in the air, it's just too difficult code anything against things. ALSO on a slightly related point, I still don't like the Windows LANGS not being hyphenated. If new users don't quote the bracketed suffix they are going to get the wrong release and keep filing 'it doesn't work' type issues .... |
Please keep all distro logo/icon work in a separate branch and PR as it requires some more preparatory work with regards to distro packaging to land the feature. |
Used arguments etc. Not setted in stone!
I want
disscussion
and approval or correction (also grammar)
PS: Not everything is implemented yet
(myiso .. )