README.md~ (editor backup file of README.md) is parsed rather than README.md

[fuminori-ido]

Hi, YARD is much better documentation tool, thank you.

When I generated a ruby project doc by YARD, old README.md was always used.
I used --no-cache option and/or remove .yardoc/ directories, but still old README.md was used.

Finally, I understood the reason. lib/yard/cli/yardoc.rb 277-th lines is as follows:

        readme = Dir.glob('README*').first

Unfortunately, README.md~ (backup file my editor is generated) is chosen for the readme file. That was the reason why generated README was old one.

I think tilde is used some major editors like Emacs so that this issue is not for only me.

Could you change like the following?:

  readme = Dir.glob('README*[A-Za-z0-9]')

or, explicitly document that backupfile like README.md~ should be delete before running YARD?

[lsegal]

Dir.glob('README*[A-Za-z0-9]') would fail if the file was just "README". We could do some tests to ensure that the last character is alphanum instead. If you submit a pull request, this functionality would be implemented much more quickly.

[fuminori-ido]

Dir.glob('README*[A-Za-z0-9]') would fail if the file was just "README".

That's true! Thank you for your comment. So, I change my glob pattern as follows:

   readme = Dir.glob('README{,*[^~]}').first

and put "pull rquest" as above. Please consider it

[lsegal]

Resolved by #790. Thanks for putting together this patch @fuminori-ido!