Skip to content

docs(package): Say what mache is in the heading and link the quickstart from PyPI #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aywrite merged 1 commit into from
Sep 30, 2026
+16 −3
Merged

docs(package): Say what mache is in the heading and link the quickstart from PyPI #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# mache
# mache: chess engine testing on GitHub Actions

[![Tests](https://github.com/aywrite/mache/actions/workflows/tests.yml/badge.svg)](https://github.com/aywrite/mache/actions/workflows/tests.yml)
[![PyPI](https://img.shields.io/pypi/v/mache)](https://pypi.org/project/mache/)

Chess engine testing on GitHub Actions, with no server to run.
Sharded fastchess matches pooled into one elo estimate or SPRT, with no server
to run.

mache runs a match between two versions of an engine on the GitHub-hosted
runners a repository already has. The match is split across jobs that run at
Expand Down
14 changes: 13 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,17 @@ dependencies = []
# What PyPI's search and its project page read. The Python versions are the
# two the tests run on, and no licence classifier is given because the licence
# field above is the expression that says it.
keywords = ["chess", "chess-engine", "elo", "sprt", "fastchess", "github-actions"]
keywords = [
"chess",
"chess-engine",
"uci",
"elo",
"sprt",
"fastchess",
"engine-testing",
"github-actions",
"continuous-integration",
]
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
Expand All @@ -37,6 +47,8 @@ classifiers = [

[project.urls]
Homepage = "https://github.com/aywrite/mache"
Documentation = "https://github.com/aywrite/mache/blob/main/docs/QUICKSTART.md"
Issues = "https://github.com/aywrite/mache/issues"
Changelog = "https://github.com/aywrite/mache/blob/main/CHANGELOG.md"

[project.optional-dependencies]
Expand Down
Loading