Skip to content

Commit 4dc123f

Browse files
basiclinesCopilot
andcommitted
Remove duplicate 'Building your own library' section from README
The Workflow section already covers the same compile/verify/lock flow. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 17016f1 commit 4dc123f

1 file changed

Lines changed: 0 additions & 74 deletions

File tree

README.md

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -239,80 +239,6 @@ bun run compile prompt --target go --out ~/my-tuikit-go
239239
3. Run `bun run compile status` — your target will show up with all specs dirty
240240
4. Run `bun run compile prompt --target {name}` and compile
241241

242-
## Building your own component library
243-
244-
The specs are designed to bootstrap a full component library in your target
245-
language. Use `--out` to point at your own project and maintain it independently.
246-
247-
### Initial compilation
248-
249-
```bash
250-
# 1. Create your project directory
251-
mkdir ~/my-tuikit-go && cd ~/my-tuikit-go
252-
go mod init github.com/myorg/tuikit
253-
254-
# 2. Generate the full compilation prompt
255-
bun run compile prompt --target go --out ~/my-tuikit-go
256-
257-
# 3. Feed the prompt to an LLM agent
258-
# Point the agent at ~/my-tuikit-go/go/_compile-prompt.md
259-
# It generates all components, tokens, and tests into ~/my-tuikit-go/go/
260-
261-
# 4. Verify everything works
262-
cd ~/my-tuikit-go/go && go test ./...
263-
264-
# 5. Lock the compiled state
265-
bun run compile lock --target go
266-
```
267-
268-
Your component library now lives in `~/my-tuikit-go/` — a standalone project
269-
you own, version, and publish independently of the specs.
270-
271-
### Incremental updates
272-
273-
When specs change (new components, bug fixes, behavior changes), you don't
274-
need to recompile everything:
275-
276-
```bash
277-
# See what changed since last compilation
278-
bun run compile status --target go
279-
280-
# Generate a prompt with only dirty specs
281-
bun run compile prompt --target go --out ~/my-tuikit-go
282-
283-
# The prompt tells the agent exactly which components to update
284-
# Feed it to the agent — it patches your existing codebase
285-
286-
# Verify and lock
287-
cd ~/my-tuikit-go/go && go test ./...
288-
bun run compile lock --target go
289-
```
290-
291-
### Extending with custom components
292-
293-
You can add components to the specs and compile them into your library:
294-
295-
1. Create `components/MyComponent/MyComponent.md` following the format
296-
2. Create `components/MyComponent/MyComponent.test.md` with behavioral tests
297-
3. Run `bun run lint` to validate against the schema
298-
4. Run `bun run compile prompt --target go --out ~/my-tuikit-go`
299-
5. The new component appears in the prompt alongside any other dirty specs
300-
301-
### Multiple targets from one spec set
302-
303-
The same specs can produce libraries for different languages simultaneously:
304-
305-
```bash
306-
# Compile to all your targets
307-
bun run compile prompt --target go --out ~/tuikit-go
308-
bun run compile prompt --target rust --out ~/tuikit-rust
309-
310-
# Each output is a standalone project with idiomatic code
311-
# Lock each target independently
312-
bun run compile lock --target go
313-
bun run compile lock --target rust
314-
```
315-
316242
## Linting
317243

318244
```bash

0 commit comments

Comments
 (0)