Add README with uv install instructions, fix pyproject.toml

- Add README.md with install/run instructions using uv
- Add build-system and script entry point to pyproject.toml
- Add .gitignore for __pycache__ and save files
- Remove placeholder main.py (entry point is h2g2.main:main)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-04-03 20:50:47 +02:00
parent f55286db8e
commit a6fe624c5e
4 changed files with 64 additions and 8 deletions
+47
View File
@@ -0,0 +1,47 @@
# The Hitchhiker's Guide to the Galaxy
A Python text adventure engine for the classic 1984 Infocom interactive fiction game, built from the original ZIL source code. The long-term goal is an accessible version for blind players via TTS/STT.
## Requirements
- Python 3.12+
- [uv](https://docs.astral.sh/uv/)
## Install & Run
```bash
# Clone the repo
git clone https://gitea.smashconsult.be/seppedl/h2g2.git
cd h2g2
# Install dependencies and run
uv run h2g2
```
Or install it into an environment:
```bash
uv pip install -e .
h2g2
```
You can also run it directly as a module without installing:
```bash
uv run python -m h2g2.main
```
## What's playable
The Earth opening sequence: wake up in your bedroom, find your gown and aspirin, make your way downstairs, head to the pub, and meet Ford Prefect.
## Project structure
```
h2g2/
engine/ # Core game engine (parser, object model, game loop)
content/ # Game content (rooms, objects, puzzles)
main.py # Entry point
*.zil # Original ZIL source code (Infocom, 1984)
docs/ # Original game manuals, maps, and story file (.z5)
```
-6
View File
@@ -1,6 +0,0 @@
def main():
print("Hello from h2g2!")
if __name__ == "__main__":
main()
+9 -2
View File
@@ -1,7 +1,14 @@
[project]
name = "h2g2"
version = "0.1.0"
description = "Add your description here"
description = "The Hitchhiker's Guide to the Galaxy - Python text adventure engine"
readme = "README.md"
requires-python = ">=3.14"
requires-python = ">=3.12"
dependencies = []
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project.scripts]
h2g2 = "h2g2.main:main"
Generated
+8
View File
@@ -0,0 +1,8 @@
version = 1
revision = 3
requires-python = ">=3.12"
[[package]]
name = "h2g2"
version = "0.1.0"
source = { editable = "." }