Skip to content

Update readme - #1739

Open
tleonhardt wants to merge 8 commits into
mainfrom
update-readme
Open

Update readme#1739
tleonhardt wants to merge 8 commits into
mainfrom
update-readme

Conversation

@tleonhardt

@tleonhardt tleonhardt commented Aug 30, 2026

Copy link
Copy Markdown
Member

For a long time I've felt like our top-level README needed a major overhaul.

I felt like it was light on useful information and delayed some of the most useful info until far down the page.

This moves the quickstart example much higher up, has it use the annoated decorator, adds an animated gif of using that toy application and removes the other images that were there.

It also attempts to put our best foot forward in the Why cmd2? section and does a better job of highlighting key features to aid with discoverability for new users.

Also:

  • Updated the getting_started.md documentation page to more closely match the current state of the getting_started.py example and added a simple animated gif.

@codecov

codecov Bot commented Aug 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.66%. Comparing base (f363707) to head (5d50825).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1739   +/-   ##
=======================================
  Coverage   99.66%   99.66%           
=======================================
  Files          23       23           
  Lines        5960     5960           
=======================================
  Hits         5940     5940           
  Misses         20       20           
Flag Coverage Δ
unittests 99.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

… the getting_started.py example

Also added a simple animated gif to that page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant