[theme-reviewers] readme.txt

Chip Bennett chip at chipbennett.net
Sat Jan 1 20:10:20 UTC 2011


To clarify:

What is *required* is that the Theme documents anything unusual,
out-of-the-ordinary, or otherwise not particularly straight-forward to the
end user. Usually, such documentation would go in a README file, but it
(right now) doesn't *have* to. It could be in the form of contextual help,
or in a Theme admin options/help page, etc.

We have had (extremely early/preliminary) discussions regarding implementing
the README markdown-parser for Extend/Themes listing pages, as currently
exists for Extend/Plugins listing pages. If that one day becomes reality,
then we will almost certainly make a markdown-compliant README file
*required*. But when (or even if) that ever happens remains to be seen - and
probably somewhere far in the future.

Until then: just remember that the intent of a README file in a Theme is to
provide any necessary information or Theme documentation that the Theme end
user might require in order to make full use of the Theme.

Chip

On Sat, Jan 1, 2011 at 10:40 AM, Edward Caissie <edward.caissie at gmail.com>wrote:

> Happy New Year!
>
> @Darren - No specific format but the discussions have lead to the idea of
> following the basic layout as a plugin readme file.
>
> This might be something that gets implemented over time, we're still
> looking at how to make the best use of the idea.
>
>
> Cais.
>
> On Fri, Dec 31, 2010 at 8:15 PM, Darren <darren at zomghow.com> wrote:
>
>> Just wondering as its only recommended is a certain format required for
>> it's content if added?
>>
>> And a happy new year to everyone! Hope you all the best in 2011 :)
>> On 1 Jan 2011 00:38, "Jay" <furcifer at furcifer.me> wrote:
>>
>> _______________________________________________
>> theme-reviewers mailing list
>> theme-reviewers at lists.wordpress.org
>> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>>
>>
>
> _______________________________________________
> theme-reviewers mailing list
> theme-reviewers at lists.wordpress.org
> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.wordpress.org/pipermail/theme-reviewers/attachments/20110101/d8857d37/attachment.htm>


More information about the theme-reviewers mailing list