From 61d3a52f9422e6829be761864be4280583874de2 Mon Sep 17 00:00:00 2001 From: htom Date: Mon, 28 Jul 2025 09:34:00 +0200 Subject: [PATCH] Readme update 1 --- README.md | 13 +++++++++++++ main.py | 1 - 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e69de29..5651ad2 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,13 @@ +This is the classic battleships game, using the terminal and pygame in python. +You use the terminal for inputting the positions, for either firing or creating the layout for your fleet. + +The project was made using the latest available python currently (Python 3.13.5). Have not tested on other versions. +It uses the uv package manager. + +To run the game: +1. Clone the repository, or download it as a zip file. Then unzip it. +2. Then run the command uv run main.py in the terminal. You should see a window pop up, and the terminal asking for you to input the position for your fleet, with instructions. + +This game was made for the boot.dev 2025 summer hackathon. This is my first major project that I have written without any kind of tutorial. I am happy with what I have achieved, +but not satisfied! I know the code is a mess and there are a lot of things I could have done better. I will fix them later, or just rewrite the whole thing to be better. +Anyways, this was really fun to make, and to those who try out this really basic and simple game, I hope you enjoy it for what it is, and thank you for trying it out even if you do not vote for it. diff --git a/main.py b/main.py index 704f6b5..d651ca4 100644 --- a/main.py +++ b/main.py @@ -42,7 +42,6 @@ def main(): screen = pygame.display.set_mode((SCREEN_WIDTH, SCREEN_HEIGHT)) - time = pygame.time.Clock() turn_counter = 0 first_iteration = True is_enemy_turn = False