ci: Move Windows to VS 2019, add rendered README to build artifact

digitalcircuit commented 4 years ago

In short

Bundle README.md and README_WINDOWS.md in Windows builds
- Save as .md.txt with Windows line endings
- Generate .md.htm HTML files via PowerShell
Move AppVeyor builds to Visual Studio 2019
- Needed to get PowerShell 7.0 on AppVeyor, used for Markdown rendering
Make README Markdown easier to read as plain text
- Inline URLs for easier access
- No difference to rendered view
- Move Running section on Windows to top
Clean up Windows build artifact
- Add win32 source directory since other source is already included
- Remove restart.in, only used on Unix

Criteria	Rank	Reason
Impact	★☆☆ 1/3	Provides better guidance for using Windows builds
Risk	★☆☆ 1/3	VS 2019 changes, larger artifacts, Markdown render bugs
Intrusiveness	★☆☆ 1/3	Documentation, Windows CI, shouldn't interfere with other pull requests

Examples

Live sample

Download the latest build artifact from AppVeyor for this pull request.

Screenshots

`README_WINDOWS.md.htm` and `README.md.htm`

Of note, links between README.md and README_WINDOWS.md automatically get converted to README.md.htm and README_WINDOWS.md.htm, including any #poundsign-hashtag-anchors to point to specific sections.

The "README_WINDOWS.md.htm" and "README.md.htm" files from the Windows build artifact open side-by-side in Firefox

Fuzzball running on Windows, no SSL/TLS

Screenshot of KDE Remote Desktop Client connected to Windows 10 on AppVeyor showing Fuzzball running, launched via cmd.exe, with Fuzzball server window open and a PuTTY window showing a successful connection to the MUCK

Zip folder contents

     206 Sep 13  2020 data
      44 Sep 13  2020 dbs
     246 Sep 13  2020 docs
 1072640 Sep 13  2020 fbmuck.exe
     928 Sep 13  2020 include
 1307648 Sep 13  2020 libeay32.dll
      12 Sep 13  2020 logs
      12 Sep 13  2020 muf
    3802 Sep 13  2020 README.md.htm
    3106 Sep 13  2020 README.md.txt
    3632 Sep 13  2020 README_WINDOWS.md.htm
    2668 Sep 13  2020 README_WINDOWS.md.txt
  148480 Sep 13  2020 restart.exe
    1062 Sep 13  2020 src
  284672 Sep 13  2020 ssleay32.dll
     136 Sep 13  2020 win32

digitalcircuit commented 4 years ago

@tanabi This is just a first pass at providing some sort of guidance within the build artifacts. I'm open to changes and/or feel free to make edits on your own!

I decided to not just copy README_WINDOWS.md into the output directory since Windows doesn't (yet?) have a default Markdown viewer. Plain text probably is best.

Edit: I've used PowerShell to render Markdown to HTML.

digitalcircuit commented 4 years ago

…ack, now I see @foxbird 's comment over on the main bug report, https://github.com/fuzzball-muck/fuzzball/issues/577 . I'll go ahead and update this - for example, I didn't realize spaces were an issue.

Edit: I haven't tested spaces or not. It's a bit late over here at the moment.

fuzzball-muck / fuzzball