Skip to content

README.md

Latest commit

 

History

History
81 lines (52 loc) · 2.48 KB

README.md

File metadata and controls

81 lines (52 loc) · 2.48 KB
Raw

Project Name

CI License: MIT

One-paragraph description of what this project does and who it is for.

Table of Contents

Overview

Describe the problem this project solves, its main features, and any key design decisions worth highlighting upfront.

Getting Started

git clone https://github.com/your-org/your-repo.git
cd your-repo
./bin/mat setup   # Git hooks, .env, dev shell (Nix/direnv/devenv), repo config

On native Windows (no WSL2), run .\bin\mat.ps1 instead.

Full setup guide (prerequisites, dependency install, dev server): docs/product-code/tutorials/getting-started.

Architecture

See docs/product-code/concept/todo_architecture-overview (template placeholder, not yet filled in).

.
├── src/           # Source code
├── docs/          # Documentation, organized by domain × type, see docs/README.md
└── .github/       # GitHub configuration

Documentation

All project documentation lives in docs/, organized by domain (what it's about) and type (what shape it takes). Start there for anything beyond this quickstart, architecture, environment variables, coding conventions, CI/CD, decisions, and more.

Contributing

Contributions are welcome. Please read CONTRIBUTING.md before opening a pull request.

License

Distributed under the MIT License.