Skip to content

README_STANDARD.md

Latest commit

 

History

History
26 lines (20 loc) · 832 Bytes

README_STANDARD.md

File metadata and controls

26 lines (20 loc) · 832 Bytes
Raw

FonijBuild README Standard

Use this structure across repositories:

  1. Centered title + one-sentence purpose
  2. Badges that communicate repository type, status, primary stack, and license
  3. Documentation / Discussions / Issues links
  4. Purpose
  5. Best for or repository-specific equivalent
  6. Baseline or Structure
  7. Quick start where applicable
  8. Project contract or contribution rules
  9. License

Badge vocabulary

  • status-active — actively maintained product/tooling repository
  • status-foundation — reusable runtime foundation

Writing rules

  • Keep the README short and decision-oriented.
  • Prefer 3-5 bullets per section.
  • Keep framework detail in repository docs.
  • Explain what the repository is, when to use it, and how to start.
  • Do not duplicate architecture documentation in the README.