Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
anantdark authored Oct 11, 2022
1 parent fad72db commit 532b683
Showing 1 changed file with 32 additions and 18 deletions.
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# hangman
# hangman

![d](https://user-images.githubusercontent.com/66427020/195121033-0fb356aa-d3d4-430a-b3cb-cd874142e82d.jpg)
<img style="float: right;" src="https://user-images.githubusercontent.com/66427020/195121033-0fb356aa-d3d4-430a-b3cb-cd874142e82d.jpg" width="250" height="250">

A simple game with easy rules, written purely in python.

GUI and CLI versions available.
## A simple game with easy rules, written purely in python.<br>
## GUI and CLI versions available.

## About the Game ##

**HangMan is an interactive real world game. The game chooses an entirely random word,and the user tries to guess it by suggesting letters untill the hangman figure is completed.**

![dg](https://user-images.githubusercontent.com/66427020/195119906-df3f12af-1606-41c1-8f63-67ac5afaff51.png)
GUI | CLI
----|----
![dg](https://user-images.githubusercontent.com/66427020/195119906-df3f12af-1606-41c1-8f63-67ac5afaff51.png) | ![dd](https://user-images.githubusercontent.com/66427020/195120456-ae346d8d-8dd7-42cd-b353-fdf19739d7b7.png)


___RULES___

![dd](https://user-images.githubusercontent.com/66427020/195120456-ae346d8d-8dd7-42cd-b353-fdf19739d7b7.png)
1. Number of Dashes represent the length of the word.
2. At each correct guess the letter is placed at its original position in the word.
3. User loses if the HangMan is completed.


## Modules used-
Expand All @@ -22,23 +28,31 @@ GUI and CLI versions available.
Use `pip install -r requirements.txt` to install the modules automatically.

## Running the game
Currently the program is not packaged into exe or any other format, so you have to run the python file directly.
~~Currently the program is not packaged into exe or any other format, so you have to run the python file directly.~~<br>
~~New contributers can implement packaging the game into an executable.~~

New contributers can implement packaging the game into an executable.
Recent Releases contain executable file for Linux.

### For Linux
- Install requisite modules(see modules section).
- Navigate to either GUI/CLI folder and run `python3 hangman.py`

### For Windows
- Run the executable.

- You can download the latest executable file from [releases](https://github.com/anantdark/hangman/releases)
- Make the file executable
```
sudo chmod +x filename
```
- Run the file `./filename`
-------------
- Run with python interpreter.
- Install requisite modules(see modules section).
- Navigate to either GUI/CLI folder and run `python3 hangman.py`
### For Window
_Dude use Linux_ :wink:
- There is no exe file for windows users. 🤐: (PRs Welcome)
- Just replace python3 with python in the above steps.
___RULES___

1. Number of Dashes represent the length of the word.
2. At each correct guess the letter is placed at its original position in the word.
3. User loses if the HangMan is completed.
# Hacktoberfest2022
<p align="center"> <img src="https://uno-website-assets.s3.amazonaws.com/wp-content/uploads/2022/09/28094927/Uno_HackFest22_Hero_V1-1536x593.jpg" alt="image" /> </p>
Expand Down

0 comments on commit 532b683

Please sign in to comment.