search

ellatrix / rename-wp-login

Rename wp-login.php
https://wordpress.org/plugins/rename-wp-login/
147 stars 71 forks source link

Rename readme.txt to readme.md #40

Closed FraGoTe closed 5 years ago

JoryHogeveen commented 7 years ago

Isn't a readme.txt required for WordPress? I don't believe it accepts .md files.

stanwmusic commented 7 years ago

https://meta.trac.wordpress.org/ticket/403

JoryHogeveen commented 7 years ago

I see and I don't think this is a good idea. The markup parsing is different. For correct usage a separate GitHub readme is still better. For example, in WP markup headings are written as == h2 == and in GitHub it's ## h2. Another reason is that a lot of info in the WP readme can be removed from the GH readme (like the changelog). You can use the Wiki for that :)

Last comment from that issue:

This was actually added 9 months ago, in [dotorg:9654]. Note that the format for both files is identical. If the readme.md exists, and readme.txt does not, then the readme.md will be used. Additionally, the readme.md is renamed to readme.txt before the official ZIP is built and released to sites. There are no plans to support GitHub flavored markdown. For this reason, we continue to recommend using the name "readme.txt" and not "readme.md", as they are unlikely to be of the same format. Additionally, GitHub uses the readme.md for entirely different purposes than the plugin directory does.

stanwmusic commented 7 years ago

I noticed that and I agree @JoryHogeveen I was just curious about it as I didn't think Wordpress handled Github Markup (.md ) and so when I found that post about it I linked it here in case it were of help. :)

JoryHogeveen commented 7 years ago

Yeah, I didn't even know WP accepted .md files at all haha

maximejobin commented 5 years ago

This PR adds no value and could potentially create problems because "markdown" and "WP markdown" are not the same.