XboxKeyboardMouse icon indicating copy to clipboard operation
XboxKeyboardMouse copied to clipboard

Recommend adding markdown support to Info contents, and sharing GitHub .md files

Open DavidRieman opened this issue 6 years ago • 0 comments

There are a few problems I think we can address:

  • Info in the app is not available on the GitHub readme files, and vice versa.
  • It should be easy to maintain parity of important information between the app's Info tab and the GitHub readme files. (Ideally without duplicating the info. Currently we have a multi-page informational document embedded inside a resource file in the app.)
  • The info tab is not formatted nicely. (It renders as plain-text in the Info tab. The text was clearly written for a fixed-width font, but Windows does not necessarily render it with a fixed-width font. IMO this does not do justice to the nice visual aesthetic up until clicking this tab.)

I think these would all be improved with a strategy where we:

  • Move the Info document to a new .md file. Update the formatting as necessary to ensure it renders well as Markdown.
  • Link the main readme.md to the new .md file. Look for opportunities to reduce duplication.
  • Either pull in an existing Markdown-capable C# control / tech, or Markdown-to-RTF conversion code, or roll some very basic Markdown processing of our own (setting just a couple RTF font properties for the various headers).
  • Update PrepareInfoTab() to display the new .md file in the Info tab.

DavidRieman avatar Feb 13 '19 03:02 DavidRieman