USB-Meter
/
Documentation
/
README.md
Newer
■
■
■
■
■
■
■
■
■
■
Older
40 lines
|
1.355kb
| 1 |
# Documentation |
|
| 2 | ||
| 3 |
This folder contains project notes, platform decisions, and collected reverse engineering material. |
|
| 4 | ||
| 5 |
It is intended to keep the repository root focused on the app itself while preserving project context in one dedicated place. |
|
| 6 | ||
| 7 |
## Working Layout |
|
| 8 | ||
| 9 |
- `Project History.md` |
|
| 10 |
Narrative context and decisions that explain how the project got here. |
|
| 11 |
- `Platform Decision - iOS 15.md` |
|
| 12 |
App-level platform choices that affect implementation. |
|
| 13 |
- `Project Structure and Naming.md` |
|
| 14 |
Naming and file-organization rules for views, features, components, and subviews. |
|
| 15 |
- `Research Resources/` |
|
| 16 |
External source material plus the notes derived from it. |
|
| 17 | ||
| 18 |
## Documentation Layers |
|
| 19 | ||
| 20 |
We keep two distinct layers of documentation: |
|
| 21 | ||
| 22 |
- project documentation |
|
| 23 |
Notes that describe our app, decisions, assumptions, and roadmap |
|
| 24 |
- research documentation |
|
| 25 |
Vendor manuals, software archives, contact sheets, protocol notes, and model-specific findings |
|
| 26 | ||
| 27 |
## Retention Rule |
|
| 28 | ||
| 29 |
Prefer keeping: |
|
| 30 | ||
| 31 |
- small curated Markdown notes |
|
| 32 |
- raw manuals and reference PDFs |
|
| 33 |
- small software artifacts that are directly useful for reverse engineering |
|
| 34 |
- one canonical copy of each vendor artifact line |
|
| 35 | ||
| 36 |
Avoid committing by default: |
|
| 37 | ||
| 38 |
- very large archives with low immediate value |
|
| 39 |
- duplicate files already represented elsewhere |
|
| 40 |
- generated exports that can be reproduced from a kept source |