Bugfixes and updated documentation

This MR contains various bugfixes and updated documentation following the discussions here and here.

The changes include:

• Making menu names bind variables
• Requiring L1 menu, HLT menu & HLT JO can be omitted with the option 'off'
• Updating argument parsing to more elegantly handle multi-word comments
• QoL improvements such as moving all extracted files to a single folder called SMK_/, changing '--l1pss' to 'l1ps', as requested by menu-experts
• Updating the list scripts to handle being passed incorrect or incomplete keys, and expanding them to return comments attached to SMKs and PSKs
• Update the prescale insert script to handle being passed incomplete keys
• Updated README and expanded help docs in the scripts to explain all features for those only accessing the scripts via the command line

Note: This version of the repo is still missing the link table for the L1 prescales. This has been added to the schema in a separate branch by @jpanduro, and I am in the process of updating the scripts to work with this in a subsequent MR.

cc: @mark @jpanduro @stelzer

Hi @jshinner ,

looks good. However, before merging, could you please ensure a uniform indentation of 4 spaces in all files?

Could we also please squash the commits?

Thanks, Joerg

added 7 commits

• 7f405beb - Update build instructions
• 8b5302fb - Make menu/prescale set names bound variables
• 2b2fcb14 - Update list scripts to provide more information
• 9999dc5e - Make L1 menu required
• beaf0fd4 - Update --comment argument to handle multiple word comments without needing to enclose it in quotes.
• fc04186d - Update documentation in README and help docs
• 1641cca5 - Various bugfixes

Compare with previous version

added 1 commit

• 5db9141a - Format scripts using Black

Compare with previous version

Hi @stelzer,

I've squashed it down to 7 commits that summarise the main changes (I think it gets squashed down further as it gets merged as well).

I've also formatted the scripts using Black, so this should take care of any indentation disparities along with any other formatting inconsistencies.

Hi @jshinner

didn't know Black but it seems to have done a good job with the indentation. Thanks.

Squashing happens during merge only if one clicks the checkbox next to the merge button (on this page), but then it squashes all commits. So squashing it manually into a few commits and not using the checkbox was the right thing to do in this case.

Cheers, Joerg

merged

mentioned in commit b148a42b