Skip to content

Add project status badges to README #15

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
wenn-id merged 2 commits into from
Jul 30, 2026
Merged

Add project status badges to README #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2516f2
docs: add project status badges
wenn-id Jul 30, 2026
f1a5032
test: validate README badges structurally
wenn-id Jul 30, 2026
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Comic Sol
Comment thread
wenn-id marked this conversation as resolved.

[![Tests](https://github.com/wenn-id/comicsol/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/wenn-id/comicsol/actions/workflows/tests.yml)
[![Release](https://img.shields.io/github/v/release/wenn-id/comicsol?include_prereleases&label=release)](https://github.com/wenn-id/comicsol/releases)
[![License](https://img.shields.io/github/license/wenn-id/comicsol)](LICENSE)
[![Python](https://img.shields.io/badge/Python-3.11-3776AB?logo=python&logoColor=white)](https://www.python.org/)
Comment thread
wenn-id marked this conversation as resolved.
Comment thread
wenn-id marked this conversation as resolved.
[![MCP tools](https://img.shields.io/badge/MCP_tools-17-brightgreen)](#mcp-server-optional)
Comment thread
wenn-id marked this conversation as resolved.
[![Platforms](https://img.shields.io/badge/platforms-Linux%20%7C%20macOS%20%7C%20Windows-blue)](docs/install.md)
Comment thread
wenn-id marked this conversation as resolved.

Comment thread
wenn-id marked this conversation as resolved.
Comic Sol is an installable Codex Skill and portable Python CLI that turns a short prompt, pasted story,
Comment thread
wenn-id marked this conversation as resolved.
or `.txt`/`.md` file into an original manga/anime comic. One natural-language
Comment thread
wenn-id marked this conversation as resolved.
invocation drives planning, character consistency, image generation, visual QA,
Comment thread
wenn-id marked this conversation as resolved.
Expand Down
31 changes: 31 additions & 0 deletions tests/test_validation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,6 +961,37 @@ def test_public_surface_uses_the_canonical_independent_repository(self):
for name in ("CONTRIBUTING.md", "SECURITY.md"):
self.assertTrue((ROOT / name).is_file(), name)
Comment thread
wenn-id marked this conversation as resolved.
Comment thread
wenn-id marked this conversation as resolved.

Comment thread
wenn-id marked this conversation as resolved.
def test_readme_badges_report_live_project_contracts(self):
Comment thread
wenn-id marked this conversation as resolved.
readme = self.readme()
Comment thread
wenn-id marked this conversation as resolved.
Comment thread
wenn-id marked this conversation as resolved.
preamble, separator, _ = readme.partition("Comic Sol is an installable")
Comment thread
wenn-id marked this conversation as resolved.
self.assertTrue(separator, "README product introduction is missing")
Comment thread
wenn-id marked this conversation as resolved.
badges = set(re.findall(r"\[!\[([^]]+)\]\(([^)]+)\)\]\(([^)]+)\)", preamble))
Comment thread
wenn-id marked this conversation as resolved.
expected = {
(
"Tests",
"https://github.com/wenn-id/comicsol/actions/workflows/tests.yml/badge.svg?branch=main",
"https://github.com/wenn-id/comicsol/actions/workflows/tests.yml",
),
(
"Release",
"https://img.shields.io/github/v/release/wenn-id/comicsol?include_prereleases&label=release",
"https://github.com/wenn-id/comicsol/releases",
),
("License", "https://img.shields.io/github/license/wenn-id/comicsol", "LICENSE"),
(
"Python",
"https://img.shields.io/badge/Python-3.11-3776AB?logo=python&logoColor=white",
"https://www.python.org/",
),
("MCP tools", "https://img.shields.io/badge/MCP_tools-17-brightgreen", "#mcp-server-optional"),
(
"Platforms",
"https://img.shields.io/badge/platforms-Linux%20%7C%20macOS%20%7C%20Windows-blue",
"docs/install.md",
),
}
self.assertEqual(expected, badges)

def test_package_files_install_and_artifact_contract_are_documented(self):
for name in ("LICENSE", "README.md", "SKILL.md"):
self.assertTrue((ROOT / name).is_file(), name)
Expand Down
Loading