Improve help text (#115)

Author: josesimoes

nanoFirmwareFlasher/Options.cs

@@ -306,14 +306,15 @@ public class Options
         public static IEnumerable<Example> Examples =>
             new List<Example>
             {
-                new("Update ESP32 WROVER Kit device with latest available firmware (stable version)", new Options { TargetName = "ESP_WROVER_KIT", Update = true }),
-                new("Update ESP32 device with latest available firmware (stable version), device is connected to COM31", new Options { TargetName = "ESP32_PSRAM_REV0", Update = true, SerialPort = "COM31" }),
-                new("Update ESP32 device with custom firmware (local bin file)", new Options { TargetName = "ESP_WROVER_KIT" , DeploymentImage = "<location of file>.bin"}),
-                new("Update specific STM32 device (ST_STM32F769I_DISCOVERY) with latest available firmware (preview version), using JTAG interface", new Options { TargetName = "ST_STM32F769I_DISCOVERY" , Update = true, Preview = true, JtagUpdate = true}),
-                new("Update specific STM32 device (NETDUINO3_WIFI) with latest available firmware (preview version), device is connected through DFU with Id 3380386D3134", new Options { TargetName = "NETDUINO3_WIFI",  Update = true, Preview = true, DfuDeviceId = "3380386D3134" }),
-                new("List all STM32 devices connected through JTAG", new Options { Platform = SupportedPlatform.esp32, ListJtagDevices = true}),
-                new("Install STM32 JTAG drivers", new Options { InstallJtagDrivers = true}),
-                new("List all available targets", new Options { ListTargets = true, Preview = true, Platform =  SupportedPlatform.stm32 }),
+                new("- Update ESP32 WROVER Kit device with latest available firmware (stable version)", new Options { TargetName = "ESP_WROVER_KIT", Update = true }),
+                new("- Update specific STM32 device (ST_STM32F769I_DISCOVERY) with latest available firmware (preview version), using JTAG interface", new Options { TargetName = "ST_STM32F769I_DISCOVERY" , Update = true, Preview = true, JtagUpdate = true}),
+                new("- Update ESP32 device with latest available firmware (stable version), device is connected to COM31", new Options { TargetName = "ESP32_PSRAM_REV0", Update = true, SerialPort = "COM31" }),
+                new("- Update ESP32 device with custom firmware (local bin file)", new Options { TargetName = "ESP_WROVER_KIT" , DeploymentImage = "<location of file>.bin"}),
+                new("- Update specific STM32 device (NETDUINO3_WIFI) with latest available firmware (preview version), device is connected through DFU with Id 3380386D3134", new Options { TargetName = "NETDUINO3_WIFI",  Update = true, Preview = true, DfuDeviceId = "3380386D3134" }),
+                new("- List all STM32 devices connected through JTAG", new Options { Platform = SupportedPlatform.esp32, ListJtagDevices = true}),
+                new("- Install STM32 JTAG drivers", new Options { InstallJtagDrivers = true}),
+                new("- List all available STM32 targets", new Options { ListTargets = true, Preview = true, Platform =  SupportedPlatform.stm32 }),
+                new("- List all available COM ports", new Options { ListComPorts = true }),
             };
     }
 

nanoFirmwareFlasher/Program.cs

@@ -51,6 +51,10 @@ public static async Task<int> Main(string[] args)
             // check for empty argument collection
             if (!args.Any())
             {
+                // perform version check
+                CheckVersion();
+                Console.WriteLine();
+
                 // no argument provided, show help text and usage examples
 
                 // because of short-comings in CommandLine parsing 
@@ -61,8 +65,12 @@ public static async Task<int> Main(string[] args)
                 var helpText = new HelpText(
                     new HeadingInfo(_headerInfo),
                     _copyrightInfo)
+                        .AddPreOptionsLine("")
                         .AddPreOptionsLine("No command was provided.")
                         .AddPreOptionsLine("")
+                        .AddPreOptionsLine("Follow some examples on how to use nanoff. For more detailed explanations please check:")
+                        .AddPreOptionsLine("https://github.com/nanoframework/nanoFirmwareFlasher#usage")
+                        .AddPreOptionsLine("")
                         .AddPreOptionsLine(HelpText.RenderUsageText(result))
                         .AddPreOptionsLine("")
                         .AddOptions(result);