From dc7eaede2b91d93160ef9f1733a3cefa5e00fbd0 Mon Sep 17 00:00:00 2001
From: acai-alicia <128638366+acai-alicia@users.noreply.github.com>
Date: Wed, 25 Sep 2024 23:23:02 -0400
Subject: [PATCH] Update README.md "How to Install"
Added a Table of Contents, a section on how to install and run the code, and further information on the game itself as well as an explanation for what GitPod is.
---
README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 51 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 07718fbb..bf90a4c6 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,64 @@
+# Table of Contents
+[Snake-Game](#headers)
+
+[Requirements for Successful Game Play](#headers)
+
+[How to Install](#headers)
+
+[Run in Gitpod](#headers)
+
+
+
# Snake-Game
The classic snake game. Made with pygame.
-You can check out my video tutorial series on how to create this game: https://www.youtube.com/watch?v=5tvER0MT14s&t=2s
+The game features an arcade game style in which users control a block shaped snake with their arrow keys.
+The main objective is to get the snake to eat randomly populated snacks.
+In return, the player's score increases. The snake also grows longer and longer, making it harder to avoid collisions and running into one's self.
+
+If you are interested on learning how to code this game yourself, you can click the YouTube link to learn: https://www.youtube.com/watch?v=5tvER0MT14s&t=2s
-# Requirements
+
+
+# Requirements for Successful Game Play
- Python 3.x
- pygame
+
+
+# How to Install
+ ## Download Python for your system from the official website:
+ - https://www.python.org/downloads/
+
+ ## Install an IDE
+ Choose and download a code editor to run the game. Two commonly used IDEs for Python are:
+ - [PyCharm](https://www.jetbrains.com/products/compare/?product=pycharm&product=pycharm-ce)
+ - [Visual Studio Code](https://code.visualstudio.com/download)
+
+ ## Download the Game Code
+ **Manual Download**
+
+ Go to the project page: [Snake Game GitHub Repository](https://github.com/techwithtim/Snake-Game/tree/master)
+ Click the green "Code" button and select "Download ZIP"
+
+ 
+ 
+
+ Once downloaded, right-click the ZIP file and select "Open in PyCharm."
+ ## Run the Game Code
+ Open the project in your IDE and click the play button to run the game. You're all set!
+
+
+
+
+
+
# Run in Gitpod
-You can also run Snake-Game in Gitpod, a free online dev environment for GitHub:
+You can also run Snake-Game in Gitpod, a free online dev environment for GitHub.
+It is useful for running code from your browser rather than going through the steps of running projects locally. It is especially useful for open source contributors:
If you're intersted in a paid subscription with GitPod use the coupon code: **TECHWITHTIM19**
[](https://gitpod.io/#https://github.com/techwithtim/Snake-Game/blob/master/snake.py)
+