Skip to content

Update README.md "How to Install" #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md "How to Install" #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 51 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,64 @@
# Table of Contents
[Snake-Game](#headers)

[Requirements for Successful Game Play](#headers)

[How to Install](#headers)

[Run in Gitpod](#headers)

<a name="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
<a name="headers"/>

# Requirements for Successful Game Play
- Python 3.x
- pygame

<a name="headers"/>

# 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"

<img width="666" alt="image" src="https://github.com/user-attachments/assets/bfc72f0a-0fdd-4ae8-bbfe-6196ca627deb">
<img width="649" alt="image" src="https://github.com/user-attachments/assets/67ec9da6-a4a4-4664-ae36-cb367111b361">

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!

<img width="1319" alt="image" src="https://github.com/user-attachments/assets/749c1a59-c529-452e-a50a-8e194bb39cb1">


<a name="headers"/>

# 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**

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/techwithtim/Snake-Game/blob/master/snake.py)