Repository navigation
Rework the README top for first-time visitors - #5
Merged
Merged
Conversation
Lead with a one-sentence description, a demo GIF of the serpentine template going from Library to STL export, a "Try it now" link to the hosted app, a short feature list, and links into the wiki. The run, citation, contributing, credit and license sections follow unchanged. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_018XwgR9JxrHkSEX7YKBcLcL
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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
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.
What this changes
Reorders the top of
README.mdso a visitor can tell what OpenChip is and open it quickly:docs/demo.gif(new, 960×600, 17.8 s, 3.9 MB). It starts from the serpentine mixer template and shows the Draw tab, the pressure and residence-time heatmaps, the X-ray and exploded 3D preview, and the STL export.src/(templates and fittings, design checks, 3D preview and export formats, flow estimates,.openchipfiles and theopenchip-designskill).The run, limitations, citation, related software, contributing, About, Acknowledgements and License sections are unchanged and follow in the same order. The old "Try it" section is now "First steps", without the duplicate app link. The two inline screenshots are removed because the GIF covers them; the image files stay in
.github/images/.The GIF was recorded with Playwright against a local dev server built from
main, and encoded with ffmpeg. A cursor was drawn on the page because headless Chromium does not record one. Notifications were hidden so they would not cover the 3D view, and one idle stretch was shortened.How it was checked
npm run build && npm test && npm run lintpass (405 tests)