Skip to content

Commit 4477856

Browse files
authored
Add sample change section to README
Updated README to include a sample change section.
1 parent e0dd580 commit 4477856

1 file changed

Lines changed: 1 addition & 55 deletions

File tree

README.md

Lines changed: 1 addition & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1 @@
1-
# Rummy
2-
3-
A modular Python implementation of the classic Rummy card game - but to be played by *agents* :)
4-
5-
### Quick start (using uv)
6-
7-
All startup, installs and test runs should use the provided uv environment wrapper from this directory.
8-
9-
1. Open a shell in the repository root and change into the RUMMY folder:
10-
11-
cd RUMMY
12-
13-
2. Run tests and install dev deps (example):
14-
15-
uv run python3 -m pip install --upgrade pip
16-
uv run python3 -m pip install pytest
17-
uv run python3 -m pytest -q
18-
19-
3. Run the example entrypoint (small simulation):
20-
21-
uv run python3 Rummy.py
22-
23-
Package usage (importing in code)
24-
25-
- From your Python code you can import the environment and game directly:
26-
27-
from rummy.env import RummyEnv
28-
from rummy.game import RummyGame
29-
30-
- Create an environment and reset to get the first observation:
31-
32-
env = RummyEnv(["Alice", "Bob"], seed=42)
33-
obs = env.reset()
34-
35-
Testing and CI
36-
37-
- The repository contains unit tests under `tests/` that validate deck size, dealing, and meld/sequence validation.
38-
- A GitHub Actions workflow at `.github/workflows/python-app.yml` runs the tests on push and pull requests.
39-
40-
Challenge notes
41-
42-
This repo is intended as a small challenge: some rules and edge cases are intentionally simplified and there are three suggested issues for contributors to improve:
43-
44-
- Fix winner detection and game-end flow
45-
- Improve meld and wildcard validation rules
46-
- Expand the RL observation/action API for agents
47-
48-
Contributing
49-
50-
- Open a PR with targeted changes and include/adjust tests to cover the change.
51-
- The CI workflow will run the test-suite automatically.
52-
53-
License
54-
55-
- This project is provided as-is for educational and challenge purposes. Add a license file if you want to publish it.
1+
## Sample Change

0 commit comments

Comments
 (0)