Repository navigation
docs: tighten README and refresh to feature-complete state - #84
Merged
Merged
Conversation
Rewrite the README to be more concise (219 lines removed, 92 added) and accurate to the current repo. The old copy was stale: "Status: pre-silicon" and a "Repository structure (planned)" tree that predated MIDI/CV, polyphony, presets, the panel, and synth_top. The new README: - opens with a crisp one-paragraph description (2D wave equation solved on an FPGA mesh, nonlinear stiffening, playable polyphonically over MIDI/CV with presets), - marks status "simulation-first, feature-complete in sim, pre-hardware" (engine + bit-exact Q1.23 reference model + playable top verified in GHDL, 23 testbenches; board bring-up next), - condenses the FPGA-vs-software trade table, the update equation, and the nonlinear/CFL story, - redraws the architecture diagram to MIDI/CV -> note mapping -> poly voices -> CDC -> I2S TX with panel and preset bank, - replaces the planned file tree with an accurate "What's here" section and a short build/simulate block. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019eBHYto9qqy1QX74vWjgxG
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.
Summary
Rewrites the README to be more concise and accurate to the current state of the repo (219 lines removed, 92 added). The old copy was stale: it read "Status: pre-silicon" and carried a "Repository structure (planned)" tree that predated MIDI/CV, polyphony, presets, the front panel, and
synth_top.What changed
src/rtl,src/tb,model,sim,syn,docs, plus a short build/simulate block.Note
The GitHub repository "About" description field is not editable through the tooling available to me. If you want it to match the new README, a suggested one-liner: "A 2D finite-difference physical-modeling synthesis engine in structural VHDL: a vibrating membrane/plate/gong solved on FPGA fabric, with a nonlinear chaos term, playable polyphonically over MIDI/CV."