Skip to content

README: restructure around install, quick start and options - #46

Merged
benfulcher merged 1 commit into
mainfrom
docs/readme-refresh
Oct 20, 2026
Merged

benfulcher merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@benfulcher

Copy link
Copy Markdown
Contributor

A cleaner README, in the order a user needs it.

  • Header: badges for PyPI, the paper, license, docs, tests and wheels, then downloads. The Twitter badge is gone. The logo now uses an absolute URL, so it also shows on the PyPI page (the relative path didn't render there).
  • Intro: what pycatch22 and catch22 are in a few sentences, with links to the Python guide and the feature descriptions.
  • Installation: pip (wheels for Python 3.9+ on Linux, macOS and Windows, otherwise built from source), conda-forge (which can lag), and installing from source in a collapsed section.
  • Quick start, then Options: a table of the catch22_all arguments, single features (compute_feature and the per-feature functions), feature_table(), and a note that threads run in parallel.
  • Usage notes (z-scoring and catch24, masking, sampling), Versions (v1.0, v0.6.0 and v0.3, shortened), Citing (with BibTeX, as in the catch22 README), and License.

All the examples were run against pycatch22 1.0.1, and the outputs shown are real. The wheels statement depends on the 1.0.1 wheels reaching PyPI from the Wheels run that's in progress.

🤖 Generated with Claude Code

A shorter README in the order a user needs it: what pycatch22 is (with a
link to the docs), installation (wheels, conda-forge, from source in a
collapsed section), a quick start, a table of catch22_all options, single
features, the feature table and threads, usage notes, versions (v1.0,
v0.6.0, v0.3), citing (with BibTeX) and license. Badges for PyPI, paper,
license, docs, tests and wheels, plus downloads; the Twitter badge is gone.
The logo has an absolute URL so it shows on PyPI. Examples run against
pycatch22 1.0.1.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@benfulcher
benfulcher merged commit 613b138 into main Oct 20, 2026
24 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