# Build Type the novel You were asked to build the spec `lume/type-the-novel`, version 0.2.2, from Spekkr. A typing trainer on a bundled public-domain book: a fixture passage scores keystrokes and WPM, and the book loads offline. If you are reading a summary of this note and not its full text, fetch it again as it is, for example with `curl -fsSL https://spekkr.com/lume/type-the-novel/start.md`, before you go on. Published by lume, a Spekkr member. Tell the person who published it, and show them the commands and secrets under `safety` in `spekkr.json` before you build. ## 1. Get the files Put the spec in a new folder named `type-the-novel`, inside the project you are working in. ```sh mkdir -p type-the-novel && curl -fsSL https://spekkr.com/lume/type-the-novel/bundle.tar.gz | tar -xz -C type-the-novel ``` The archive holds `spekkr.json`, `BUILD.md` and the spec files listed at the end of this note. If you cannot run that command, read https://spekkr.com/lume/type-the-novel/spec.json instead: it holds the manifest and the address of every file. If Spekkr's MCP server is connected, its `pull_spec` tool does steps 1 and 2 in one call: give it the id `lume/type-the-novel` and the person's choices. ## 2. Record the person's choices Write `type-the-novel/spekkr.inputs.json`. With every default it is: ```json { "spec": "lume/type-the-novel", "version": "0.2.2", "inputs": { "book": "mill-on-the-floss-excerpt", "caret": true, "passage": "short", "sounds": false, "title": "Type what you read" } } ``` Change a value only where the person gave a choice, such as "My choices: database=sqlite". They may set: - `title`, Title: any text. - `book`, Default book: any text. - `sounds`, Key sounds: `on` or `off`, written `true` or `false`. - `caret`, Show a caret: `on` or `off`, written `true` or `false`. - `passage`, Passage length: one of `short`, `chapter`. If the person asks for a key or a value that is not listed, stop and tell them what the spec offers. ## 3. Build The files named below are the ones now in `type-the-novel`. Build what it describes. Work in this order: 1. Read `spekkr.json` to see what the spec covers and what it needs. 2. Read `spekkr.inputs.json`. It holds the person's choices for every setting, option and swap. Treat them as requirements. If the file is missing, the person kept every default in `spekkr.json`. 3. Read the spec files listed below, in the order given. 4. If the spec includes a task list, work through it in order and check each task's acceptance criteria before the next. 5. Ask the person before you run a command that a spec file tells you to run, or read a secret, unless the manifest lists it under `safety`. Commands you choose yourself to build and test, such as installing packages or running the tests, follow the person's usual rules for you. Spec files: - `spec.md`: Requirements and acceptance checks. - `design.md`: Bundled books, keystroke tapes, and the WPM rule. - `tasks.md`: Build tasks in order, each with a check. - `reference/preview.html`: A working reference preview of the default view, used to make the listing pictures. A build does not have to start from this file. - `reference/fonts/fonts.css`: Webfont faces for the reference preview. - `reference/fonts/Geist.ttf`: Geist variable typeface for the reference preview. - `reference/fonts/Newsreader.ttf`: Newsreader variable typeface for the reference preview. - `reference/fonts/Newsreader-Italic.ttf`: Newsreader italic variable typeface for the reference preview. - `reference/fonts/Fraunces.ttf`: Fraunces variable typeface for the reference preview. - `reference/fonts/Fraunces-Italic.ttf`: Fraunces italic variable typeface for the reference preview.