Opened 20 months ago

Closed 7 months ago

Last modified 7 months ago

#10946 closed defect (fixed)

MAC OS X: README.html contains invalid links for locally bundled files.

Reported by: macca8 Owned by: criezy
Priority: normal Component: Port: Mac OS X
Keywords: Cc:
Game:

Description

This bug is directly related to changes made to the README.md file by commit e271cdc, when it was merged as part of the RISCOS-related PR1587 on 18 April 2019.

Prior to this commit, the ‘Credits’ section of the README file contained a link to ScummVM’s online Credits page (<https://www.scummvm.org/credits/>).
This changes that link to target the locally bundled AUTHORS file.

Mac OS X daily builds are bundled with the improved AUTHORS.rtf file, not the plain text AUTHORS file, so this link returns a ‘File not found’ error in the web browser.

In addition, a new Section 11 (‘Changelog’) has been added to the README file, which contains a link that targets the locally bundled NEWS.md file.

Mac OS X daily builds are bundled with both a plain text NEWS.md file and a NEWS.html file. In this case, the link returns the plain text version, instead of the properly formatted html version (which actively links to ScummVM’s online Commit page).

Both of these files (AUTHORS.rtf & NEWS.html) are easily, and correctly, accessed from the ScummVM app’s Help Menu, so I don’t see any value duplicating these links in the README.html file.

The online Credits page link at least offers a version with navigation links, and doesn’t require TextEdit to launch, so it’s worth retaining in the README.

Personally, I’d prefer to see the commit reverted, at least as far as Mac OS X is concerned.

Current Daily Build: 2.1.0git5224-gc84943cbc7(24 April 2019)
Platform: Intel Mac (OS X 10.6.8, 10.11.6)

Change History (3)

comment:1 by macca8, 14 months ago

Since the v2.1.0 release build is built independently, will it include a fix for the broken Credits link in the README.html file?

... and the answer is NO! It's still 'file not found'.

Last edited 13 months ago by macca8 (previous) (diff)

comment:2 by criezy, 7 months ago

Owner: set to criezy
Resolution: fixed
Status: newclosed

Thank you for your report.

I have now updated the links in the bundled README.html file:

  • The link to NEWS.md now points to the bundled NEWS.html file.
  • The link to AUTHORS now points to the online credits page (as it used to).
  • The CONTRIBUTING.html file is now bundled in the application, and the link to CONTRIBUTING.md at the top (the PRs Welcome button) now points to the bundled CONTRIBUTING.html.

comment:3 by macca8, 7 months ago

Thank you. Always nice to see a loose end tied up.

Note: See TracTickets for help on using tickets.