Here’s a clean, simple, and professional README for your Boot.dev Asteroids project, with instructions for running the game using uv.
You can paste this directly into your README.md:
This repository contains a simple Asteroids-style game built with Python and Pygame as part of the Boot.dev “Build Asteroids in Python” guided project. The project focuses on game loops, object movement, collision detection, and basic game structure using Pygame.
- Player-controlled spaceship
- Asteroid spawning and movement
- Basic collision system
- Game loop architecture
- Clean and modular Python code
- Uses Pygame for rendering and input
Linux/macOS
curl -LsSf https://astral.sh/uv/install.sh | shWindows (PowerShell):
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"git clone https://github.com/yourusername/asteroids
cd asteroidsSimply run:
uv syncThis will:
- Create the
.venvenvironment - Install Pygame and all required dependencies
- Ensure the correct Python version is used
uv run main.pyOr, if you want to activate the environment manually:
Linux/macOS:
source .venv/bin/activate
python main.pyWindows:
.\.venv\Scripts\activate
python main.py- Arrow Keys / WASD: Move the ship
- Spacebar: Shoot
- Escape: Quit game