as_readme_text

Warning

🚧 Sprout is still in active development and evolving quickly, so the documentation and functionality may not work as described and could undergo substantial changes 🚧

as_readme_text(properties: PackageProperties)

Create a human-readable version of the properties as a README string.

Convert the properties object into human-readable version as Markdown-formatted text. Use this to generate the text for a README.md file and save it using write_file().

Parameters

properties : PackageProperties

A PackageProperties object containing the package and resource properties.

Returns

str

A Markdown-styled string to eventually save as a README.md file.