htamas1210/battleships
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme update 2

Browse Source
This commit is contained in:
htom
2025-07-28 09:53:33 +02:00
parent 61d3a52f94
commit 83373d1d73
4 changed files with 20 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,13 +1,18 @@
# Battleships
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.
![preview battleships](/screenshot/preview.png)
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,
## To run the game:
1. Clone the repository with `git clone https://github.com/htamas1210/battleships.git`, or download it as a zip file, by clicking on the green Download button, then clicking Download Zip. Then unzip it.
2. In the folder that you dowloaded, open a terminal window. Then run the command `uv run main.py` in the terminal, this will run the game. You should see a window pop up, and the terminal asking for you to input the position for your fleet, with instructions.
3. If you are done with the game. In the terminal window press Ctrl+C to exit early.
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 (or ai). 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.