Repository navigation
README: restructure around install, quick start and options - #46
Merged
Merged
Conversation
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>
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.
A cleaner README, in the order a user needs it.
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.catch22_allarguments, single features (compute_featureand the per-feature functions),feature_table(), and a note that threads run in parallel.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