Skip to content
This repository has been archived by the owner on Dec 30, 2023. It is now read-only.

Latest commit

 

History

History
9 lines (7 loc) · 448 Bytes

contrib-docs.md

File metadata and controls

9 lines (7 loc) · 448 Bytes

Building the Docs

To update the README.md file a tool called verb is used.
But basically you don't have to care about it, just follow a few simple rules:

  • Do not change the README.md file.
  • Instead do changes in the .verb.md file and in all related *.md file in the ./docs directory.
  • Then just run make gen-readme
    • This will use docker-verb to update the README.md file.