Individual Readme behaviour in plugin repo template

[Yanncha]

Hi !

I've started to use your plugin repo template. Thanks for sharing it !
I managed more or less to configure it, but it is not clear to me whether individual Readme.md are written out when the release action is run, if they have both a static and dynamic part like global Readme, or if they are purely static.

How is it supposed to be ?

Cheers !
Yanncha

[zuckung]

uh nice, another template user, will link your repo inside my readme :)

i m not sure if i understand the question, so i explain the whole process.

on release action, all the plugins get read and the global readme is written out of the template.txt and the plugin contents.
inside the file res/src/makemd.py you find this section of variables that can be used inside the template.txt

	# useable variables inside template.txt:
	# %news%                html table of the news
	# %pluginlist%          html table of anchor links to the plugins
	# %name%                the plugin name
	# %icon%                html img with plugin icon url
	# %assetfile%           release zip name of the plugin, special chars and spaces are replaced by dots
	# %assetfullpath%       url to the plugin release
	# %size%                plugin size in mb or kb, or 'N/A' if no release found
	# %lastmodified%        last modified date of the plugin release zip file, or 'N/A' if no release found
	# %pluginurl%           url path to the plugin folder
	# %pluginnameurl%       plugin folder name, with space replaced by %20
	# %imagemdamount%       number of graphic files in the plugin images md
	# %description%         content of the plugin's' plugin.txt or about.txt, or 'N/A' if none found
	# %readme%              content of the plugin's' README.md or 'N/A' if none found
	# %screenshots%         html table of the plugin screenshots from the screenshot folder, or '' if none found
	# %version%             version number
	# %orgrepo%             organisation/repository
	# %organisation%        organisation
	# %repository%          repository
	# %sizebadge%           plugin size in mb or kb, or 'N/A' if no release found, space is replaced by "_"
	# %lastmodifiedbadge%   last modified date of the plugin release zip file, or 'N/A' if no release found, "-" is replaced by "--"

maybe the repo template is a bit outdated and has less variables.
here are 2 variables that may answer your question, %readme% and %description%, and the source files their content comes from. the plugin content is static and gets only read. well, again the template is outdated, my repo takes for example the version number and writes it into the plugin.txt before releasing the plugin.

if you want functions like that(or a variable for the actual plugin version number), just copy the .github/workflows/.yml files and the res/src/.py files. think you have to adjust some of the yml to your values described in the instructions.md .

[Yanncha]

Hi !

Thanks for your answer. This is more or less what I understood regarding main Readme.md.
My question was rather on the Readme.md located within each plugin directory : should I update its content manually ? Or does it get written by some script ?

[zuckung]

the plugin readme.md is written by yourself. it should contain a more detailed description of the plugin and whatever else you want the users to know. it just gets read and is written into the global readme under the expandable readme click link.

# %readme% content of the plugin's' README.md or 'N/A' if none found

[zuckung]

aaaaaand, you are inside my readme!

if you have more questions, or need support, or have amazing ideas on how to make the repo better, feel free to tell me ;)

[Yanncha]

Thanks !
Yes, I'll tell you if I have some ideas.