docs: add readme stub pointing at sprint plan
- SHA
a471afa13dee5e426172b4ecd2ae7c0ea2cfcb25- Parents
-
7ac4707 - Tree
313ebf6
a471afa
a471afa13dee5e426172b4ecd2ae7c0ea2cfcb257ac4707
313ebf6| Status | File | + | - |
|---|---|---|---|
| A |
README.md
|
29 | 0 |
README.mdadded@@ -0,0 +1,29 @@ | ||
| 1 | +# DocumentLanguageModel | |
| 2 | + | |
| 3 | +> A text file with a `.dlm` extension becomes a local, reproducible, trainable LLM. | |
| 4 | + | |
| 5 | +Edit the document, retrain, share. Not a toy — LoRA/QLoRA on a real pretrained | |
| 6 | +base, exportable to Ollama. | |
| 7 | + | |
| 8 | +**Status:** pre-alpha (Sprint 01 of 29). See `.docs/sprints/00-index.md` for the | |
| 9 | +development plan. | |
| 10 | + | |
| 11 | +## Installation | |
| 12 | + | |
| 13 | +``` | |
| 14 | +uv sync | |
| 15 | +uv run dlm --help | |
| 16 | +``` | |
| 17 | + | |
| 18 | +## Project layout | |
| 19 | + | |
| 20 | +``` | |
| 21 | +src/dlm/ Package sources | |
| 22 | +tests/ Test suite | |
| 23 | +.docs/ Planning documents (local-only; gitignored) | |
| 24 | +.refs/ Cloned reference projects (local-only; gitignored) | |
| 25 | +``` | |
| 26 | + | |
| 27 | +## License | |
| 28 | + | |
| 29 | +MIT | |