ThemePackagerComponent icon indicating copy to clipboard operation
ThemePackagerComponent copied to clipboard

How to add readme and changelog

Open adamwintle opened this issue 11 years ago • 10 comments

Sorry if this is already in the package somewhere but I can't find it - how can I add a readme and changelog to the theme packages?

adamwintle avatar Feb 06 '14 22:02 adamwintle

Here? https://github.com/modxcms/ThemePackagerComponent/tree/develop/core/components/themepackagercomponent/docs

sepiariver avatar Feb 13 '14 20:02 sepiariver

I would really like to know s well... (bit in a hurry actually with this)

DESIGNfromWITHIN avatar Mar 23 '14 20:03 DESIGNfromWITHIN

Is the /core/docs/ folder contents not being added to the _build script? Just trying to lock down what's missing...

Thanks all,

sepiariver avatar Mar 25 '14 16:03 sepiariver

No it is not... I have my docs files in:

/core/components/ivory/docs/

They are not shown on install, they are added to the files after installing the package.

DESIGNfromWITHIN avatar Apr 10 '14 08:04 DESIGNfromWITHIN

I notice that the current themes also do not have any changelog, readme or licence included when you install them, seems like a important feature!

DESIGNfromWITHIN avatar Apr 10 '14 11:04 DESIGNfromWITHIN

+1 for option to choosing a doc, license and readme file.

wuuti avatar Apr 15 '14 10:04 wuuti

Come on, this is really important!

DESIGNfromWITHIN avatar Apr 18 '14 07:04 DESIGNfromWITHIN

+1

sottwell avatar Jun 13 '14 19:06 sottwell

+1

tomashina avatar Aug 19 '14 12:08 tomashina

I found a workaround to include changelog, readme or licence in your transport package. Just open transportfile and edit manifest.php and on line 5, just before 'setup-options' => '... add code:

'license' => 'Licence text', 'readme' => 'Readme text', 'changelog' => 'Changelog text',

Not the perfect solution but it works. Hope this helped.

tomashina avatar Aug 19 '14 13:08 tomashina