readme.md

readme.md is the documentation for a Unit and the most important file in any repository. How easy it is for other people to use a Unit depends directly on how complete and clear this file is.

TIP

To keep Unit documentation consistent, every Pepeunit instance provides a readme.md generator based on pepeunit.toml. The generator converts machine-readable pepeunit.toml into a human-readable readme.md.

Generating readme.md

INFO

To find the generator, click your nickname in the top‑right corner, then click the Generate README.md button. You will be prompted to select a pepeunit.toml file. Once you confirm the file, readme.md will be generated and downloaded automatically.