feat(package): add project metadata, release configuration, and README documentation
This commit is contained in:
41
readme.md
Normal file
41
readme.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# @maintainable.xyz/house-spec
|
||||
|
||||
The open specification for building maximally maintainable, healthy homes.
|
||||
|
||||
## What This Is
|
||||
|
||||
A complete, opinionated building specification for a Baufritz timber-frame house engineered around **clean-room-level indoor air quality** and **lifetime maintainability**. Every system — air filtration, heating, flooring, wiring — is designed so that components can be inspected, serviced, and replaced without destructive intervention.
|
||||
|
||||
## Specification Documents
|
||||
|
||||
| Spec | Scope |
|
||||
|------|-------|
|
||||
| [01 — Air System](specs/01-air-system-spec.md) | H13 HEPA whole-house filtration, MVHR, steam humidification, duct design, pressure management |
|
||||
| [02 — Sensors & Automation](specs/02-sensor-automation-spec.md) | Per-room air quality sensors, KNX/Zigbee architecture, Home Assistant integration, demand-controlled ventilation |
|
||||
| [03 — Baufritz Coordination](specs/03-baufritz-coordination-spec.md) | Technical room, duct routing, airtightness, radon protection, construction checkpoints |
|
||||
| [04 — Flooring & Ceiling](specs/04-flooring-ceiling-spec.md) | Lindner NORTEC Doppelboden raised floor, WOODline parquet, Plafotherm AirHybrid radiant ceiling |
|
||||
|
||||
## Key Design Principles
|
||||
|
||||
- **Whole-house H13 HEPA** — 99.95% particle capture at 0.3 um, ISO Class 7-8 equivalent
|
||||
- **Every air parameter controlled** — particulates, CO2, VOCs, humidity, temperature, pressure, radon
|
||||
- **Heating via ceiling** (Plafotherm AirHybrid), not floor — fast response, furniture-independent, integrates MVHR supply air
|
||||
- **Raised access floor** (Lindner NORTEC Doppelboden) — individually liftable 600x600 mm panels for full access to services underneath
|
||||
- **Dry construction throughout** — no wet trades, ideal for Baufritz timber-frame
|
||||
- **Positive pressure** (+3-5 Pa) — unfiltered air never enters the building envelope
|
||||
|
||||
## PDF Build
|
||||
|
||||
The specs can be compiled into a single styled PDF with rendered Mermaid diagrams:
|
||||
|
||||
```sh
|
||||
pnpm install
|
||||
pnpm build
|
||||
# Output: dist/house-spec.pdf
|
||||
```
|
||||
|
||||
Requires Chromium (installed automatically via Puppeteer).
|
||||
|
||||
## License
|
||||
|
||||
All rights reserved. Copyright maintainable.xyz.
|
||||
Reference in New Issue
Block a user