docs: write the project README & add a mascot #1

	name: ci

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]

	permissions:
	contents: read

	jobs:
	ci:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout ${{ github.repository }}
	uses: actions/checkout@v6
	with:
	fetch-depth: 1

	- name: Set up Python
	uses: actions/setup-python@v6
	with:
	python-version: "3.14"
	cache: pip
	cache-dependency-path: pyproject.toml

	- name: Create venv and install dependencies
	run: \|
	python -m venv .venv
	. .venv/bin/activate
	python -m pip install --upgrade pip
	pip install -e . --group dev
	echo "$PWD/.venv/bin" >> "$GITHUB_PATH"

	- name: Lint (ruff check)
	run: ruff check

	- name: Format (ruff format --check)
	run: ruff format --check

	- name: Type check (pyright)
	run: pyright

	- name: Tests (pytest)
	run: pytest

Navigation Menu