Repository navigation
Rewrite the README for users - #30
Merged
Merged
Conversation
Lead with a quick start (Colab, pip + notebook, browser, desktop app), describe features by what they do, and put both CLIs' options in one table instead of a dense paragraph that rendered badly. Document the headless SVG export, list the Linux build packages, and drop the outdated 'default canned design' server example (a design is required). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The command-line section was a dense paragraph that rendered badly on GitHub, and the README read as developer notes more than as a guide for someone who wants to use the viewer.
pip install+naja_schematic.show(), thenaja-schematic --openbrowser server, the desktop app--export/--trace/--equipotential/--focus) documented; it was missingChecked with GitHub's markdown renderer: no stray backticks, 5 tables.
🤖 Generated with Claude Code