Show readme.txt from Themes

[zodiac1978]

The readme.txt should be used to document any dependencies of a theme. But if we install the theme from inside WordPress there is no way to see the readme.txt for an unexperienced user.

For example the Sela theme needs Jetpack to show Testimonials.
See readme.txt: ​https://themes.svn.wordpress.org/sela/1.0.9/readme.txt

But the theme page is not mentioning that (​https://wordpress.org/themes/sela/) and there is no direct link or presentation of the readme.txt with this essential information on the theme page or inside WordPress.

I suggest showing the readme.txt somewhere or use a system like ​https://github.com/TGMPA/TGM-Plugin-Activation to give this information to the user.

[jcastaneda]

There is one that was opened three years ago: #22810

And one for meta as well:
​https://meta.trac.wordpress.org/ticket/45

[ocean90]

For changelogs see #22810 and ​#meta45, for displaying the data see #25707 and ​#meta215.

Going to close this as maybelater since a readme.txt ​is currently not a requirement and it doesn't seem like there is a standard yet. This should be discussed with the theme review team first.

[zodiac1978]

I suggest re-opening, because ​#meta215 is for the Theme directory and ​#meta45 is for changelogs. What is about showing readme.txt in WordPress core (/wp-admin/themes.php)?

[ocean90]

Replying to zodiac1978:

I suggest re-opening, because ​#meta215 is for the Theme directory and ​#meta45 is for changelogs. What is about showing readme.txt in WordPress core (/wp-admin/themes.php)?

Changelogs are probably part of the readme.txt. But still, my main reason was:

… a readme.txt ​is currently not a requirement and it doesn't seem like there is a standard yet. This should be discussed with the theme review team first.

We can't display something that doesn't exist and/or has a proper specification.

[zodiac1978]

Replying to ocean90:

We can't display something that doesn't exist and/or has a proper specification.

Couldn't we check if a readme.txt exists and if it does, show it completely in a (disabled/non-editable) textarea?

[zodiac1978]

If you don't want to wait for a solution on wp.org, there is a plugin for showing at least the changelogs:
​https://wordpress.org/plugins/wp-theme-changelogs/

[zodiac1978]

Themes are recommended to include a readme.txt file, using plugin directory’s readme.txt markdown format. This recommendation will soon become required.

​https://developer.wordpress.org/themes/release/writing-documentation/

Maybe this ticket could be revisited if a readme.txt is required.

I'm still convinced that we are violating the attribution requirement if we hide those attributions in a readme.txt which is not shown to any backend user.

Declare licenses of any resources included such as fonts or images.

This requirement from the theme team is typically handled through a readme.txt.

[joyously]

Replying to zodiac1978:

Maybe this ticket could be revisited if a readme.txt is required.

The readme.txt file is required as of Oct 25, 2018.

​https://make.wordpress.org/themes/handbook/review/required/#readme-txt-file

[SergeyBiryukov]

Per ​https://meta.trac.wordpress.org/ticket/215#comment:42, this needs design both for theme pages on WordPress.org and for theme modals in core. Adding the keyword.

[mapk]

This was recently discussed in a [Design Team feedback session in Slack]​https://wordpress.slack.com/archives/C02S78ZAL/p1602696169288400.

While redesigning the theme modals in wp-admin or redesigning the theme detail page on w.org to display the readme text would be great, an interim solution might be the way to go right now.

How about adding a link in the "Browse code" section on the theme details page?

And then linking to the detail page on w.org from the theme modal in wp-admin.

[SergeyBiryukov]

Moving to the milestone to implement comment:26.

[chaion07]

Hi @zodiac1978! Thank you for reporting this. This ticket was discussed during a recent ​Bug-scrub session. Based on the feedback received we're updating the ticket with milestone being changed. The feature freeze date is inching close so this needs a patch. Thus requesting attention from contributors if possible. Thanks!

[chaion07]

We reviewed this ticket during a ​recent bug-scrub session. Mark's comment actually covers the design feedback. So we are removing the keyword.

Props to @joyously for pointing this out.

Cheers!

[chaion07]

Thanks @zodiac1978 for reporting this. With Beta 01 coming into effect by the end of today and with the lack of progress we are updating the milestone on this ticket to Future Release. Cheers!

[poena]

Unfortunately this was not included in the theme directory re-design that took place in 2024: ​https://make.wordpress.org/meta/2024/06/19/the-theme-directory-gets-a-refresh-and-is-now-powered-by-blocks/

The readme, including the theme changelog, is still not available in the theme directory.

It would still be appropriate and helpful to link to the theme page from the theme details; instead of only linking to the theme author.