Fix README Description to match main - #21
Merged
Merged
Conversation
The Description section listed 7 sub-projects as if they were all part of this repos scope, then claimed Busemann Inlet Design, Turbo Ramjet Cycle Analysis, and Viscous Corrections were merely planned but not yet started. That was wrong for Busemann Inlet specifically: there are 57 unmerged commits of real (if messy) implementation work on the origin/Busemann-Inlet branch. Compression/Expansion Surfaces was also listed as a completed sub-project, but main only has the compression (lower-surface) side implemented -- the expansion/upper-surface side only exists as WIP on origin/expansion_surface_design, unmerged. Replaced the aspirational sub-project list with a description grounded in what src/ on main actually does today, matching the already-accurate Project Structure section below it. Added one honest line noting that upper-surface/inlet work exists on other unmerged branches, rather than either pretending it does not exist or overclaiming it as a current capability.
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 Description section claimed Busemann Inlet was planned but not started (57 unmerged commits say otherwise) and listed Compression/Expansion Surfaces as done when only the compression side is in main. Rewrote it to describe only what src/ on main actually implements, matching the Project Structure section below it.