hermes-bsd/optional-skills/software-development/code-wiki/templates
..
architecture.md
getting-started.md
module.md
README.md

{{PROJECT_NAME}}

{{ONE_PARAGRAPH_DESCRIPTION}}

Key Concepts

  • {{CONCEPT_1}} — {{ONE_LINE}}
  • {{CONCEPT_2}} — {{ONE_LINE}}
  • {{CONCEPT_3}} — {{ONE_LINE}}

Entry Points

High-Level Architecture

{{TWO_TO_THREE_SENTENCES}}

See architecture.md for the full picture.

Module Map

Module Purpose
{{MODULE_1}} {{ONE_LINE_PURPOSE}}
{{MODULE_2}} {{ONE_LINE_PURPOSE}}

Getting Started

See getting-started.md.