Skip to content

docs: rewrite the README, add citation info and animated walkthroughs - #125

Merged
thethinkmachine merged 2 commits into
mainfrom
claude/clever-brown-57ki29
Oct 1, 2026
Merged

docs: rewrite the README, add citation info and animated walkthroughs#125
thethinkmachine merged 2 commits into
mainfrom
claude/clever-brown-57ki29

Conversation

@thethinkmachine

@thethinkmachine thethinkmachine commented Oct 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Summary

README rewrite

  • Reorganised around getting started (web, desktop, from source), features, algorithms and theory, the CLI, development, known issues, contributing and license.
  • Added badges and quick links to the web app, the desktop release and the machine library.
  • Corrected the machine count from 29 to 30. The Embedded PDA wasn't listed.

Citation

  • New CITATION.cff, which turns on GitHub's "Cite this repository" button.
  • New Citation section in the README with BibTeX and APA entries.

Animated walkthroughs (docs/media/*.webp, about 9.7 MB in total)

  • Six animated WebP clips, recorded in the light theme. Each sits under the feature it shows:
    • Machine Wizard: builds a DFA and runs its test word.
    • Building blocks: groups states into blocks, drills into one, then runs the machine.
    • Space-time diagram: the BB(2,4) champion, computed to its halt after 3,932,964 steps.
    • Grammar workbench: a CYK table, then an ambiguity witness.
    • StateMate: builds a balanced-brackets PDA from one prompt.
    • CLI: automata halts covering every proof method, then check-proof.
  • The StateMate clip was recorded through tools/agent-bridge. The answer went through the app's normal parse, lint and verify steps, and the caption says so.
  • The animated grammar.webp replaces grammar.png in the README. The PNG file stays in docs/media.

Notes

  • The existing screenshots are dark-themed and the new clips are light, so the README mixes the two.
  • The space-time clip loads a copy of bb2x4.automaton with maxTmSteps raised to 4,000,000. With the default 10,000-step limit, the library file stops long before the machine halts.

🤖 Generated with Claude Code

https://claude.ai/code/session_017YKJF9uBDjB19vfGA1XE2k

claude added 2 commits October 1, 2026 03:27
@claude
docs: rewrite the README and add a CITATION.cff
a50ad19 
Restructures the README around getting started (web, desktop, source),
features, the CLI and development, and adds a Citation section with
BibTeX and APA entries. CITATION.cff enables GitHub's "Cite this
repository" button.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017YKJF9uBDjB19vfGA1XE2k
@claude
docs: add animated walkthroughs to the README
c4add3e 
Six animated WebP clips, recorded from the running app in the light theme:
the Machine Wizard, building blocks (group, drill in, run), the space-time
diagram of the BB(2,4) champion run to its halt, the grammar workbench
(CYK and an ambiguity witness), StateMate building a PDA through the agent
bridge, and the CLI's halts / check-proof.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017YKJF9uBDjB19vfGA1XE2k
Copilot AI balanced review requested due to automatic review settings October 1, 2026 04:31
Copilot AI reviewed Oct 1, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 1, 2026

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@thethinkmachine
thethinkmachine merged commit 8969c84 into main Oct 1, 2026
5 checks passed
@thethinkmachine
thethinkmachine deleted the claude/clever-brown-57ki29 branch October 1, 2026 04:32
@thethinkmachine thethinkmachine changed the title docs: rewrite the README, add citation info and animated walkthroughs docs: rewrite the README, add citation info, feature guides and walkthrough clips Oct 1, 2026
@thethinkmachine thethinkmachine changed the title docs: rewrite the README, add citation info, feature guides and walkthrough clips docs: rewrite the README, add citation info and animated walkthroughs Oct 1, 2026
@thethinkmachine thethinkmachine mentioned this pull request Oct 1, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Balanced
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@thethinkmachine @claude