Skip to content

Attach a README.md file for the app_templates to follow #35

@Circuit-Overtime

Description

@Circuit-Overtime

Problem Statement

The reporter asks for a README.md file to be attached for the app_templates to follow. The specific location, required contents, and whether this applies to all template apps or only one template are not stated.

Tasks

  • Add a README.md for app_templates.
  • Scope to be defined once the questions below are answered.

Checklist

  • README.md added in the intended template location
  • Template content reviewed against the expected app template structure
  • Documentation changes checked for consistency with existing repo docs

Questions from @elixpoo

  • Should the README.md be placed at app_templates/ or inside each example app directory?
  • What sections should the template README require for new app templates?
  • Should the README describe only the template structure, or also include usage and contribution guidance?
  • Are both example_app_first and example_app_second expected to follow the same README format?

Metadata

Metadata

Labels

DEVCategory: DevMEDIUMPriority: Medium

Type

No fields configured for Task.

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions