Skip to content

Refresh the front page (README + docs index) for 1.0 - #172

Merged
ccaprani merged 1 commit into
mainfrom
feature/readme-refresh
Jun 27, 2026
Merged

ccaprani merged 1 commit into
mainfrom
feature/readme-refresh

Conversation

@ccaprani

Copy link
Copy Markdown
Owner

Rewrites the front page to match what PyCBA actually is at 1.0 — a complete continuous-beam toolkit — instead of the old "a Python port of the MATLAB code" blurb.

  • README: tagline, badge row (PyPI / Python / Tests / codecov / docs / Apache-2.0 / black), a hero result figure, a runnable quickstart, grouped feature highlights (analysis · loads & bridges · visualisation · ergonomics), install, docs links, and an Origins note keeping the MATLAB/C++ heritage.
  • docs index: matching capability summary; fixed the wrong badges (issues/PRs/PyPI pointed at ospgrillage; license said MIT — it's Apache 2.0).
  • Quickstart snippet verified to run; docs build clean.

🤖 Generated with Claude Code

Rewrite README and docs index to reflect the full toolkit (linear + nonlinear +
modal + moving-load bridges + foundations + prestress + rich visualisation)
rather than 'just a MATLAB port'. Add a badge row (PyPI, Python, Tests, codecov,
docs, Apache-2.0, black), a hero result figure and a quickstart; fix the wrong
docs badges (ospgrillage -> pycba, MIT -> Apache 2.0). The MATLAB/C++ origin is
kept as an 'Origins' note.
@ccaprani
ccaprani merged commit f66c179 into main Jun 27, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant