The program is for a Python programming course. Documentation is for a technical writing task.

This document will explain step-by-step how to run and play the program wisielec.py on Linux (Ubuntu) in 4 simple steps.

• If you already know how to run Python scripts on Linux, go straight to Step 4!

Step 1 Make sure Python 3 is installed on your computer or install it.

Step 2 Download the source code from a GitHub repository.

Step 3 Run the program.

Step 4 Play hangman.

Linux distributions may include an outdated version of Python (Python 2), make sure Python 3 is installed on your machine before running the program.

Remember to be careful while using the command line, because you might accidentally damage or remove your data. Write only commands that you know what is their purpose.

Access to a command-line/terminal window on Linux:

               Ctrl-Alt-T

To find out if Python3 is installed, type the command:

                python3

• If your version is Python 3.7.x (x stands for the revision level and could change as new releases come out), go to Step 2.

• To install Python 3, write sudo apt-get install python3 in the terminal or go to https://www.python.org/downloads/

If you are a beginner, reading the following guide is recommended https://wiki.python.org/moin/BeginnersGuide as well.

More details on Python can be found on the official Python page and on its Wikipedia page.

Download the source code of the Python program you want to run from a Github repository.

You can download either:

• a single Python source code file (with extension .py) First, click on wisielec.py to go to the specific file. Then, click on Raw to open the raw source code. After that, you can copy it using CTRL+C and save it into a new .py file.

• a ZIP file containing the Python file (the source code), a Markdown file (which you are currently reading), and two text files (containing a list of words which you can use to play the game).

• It is also possible to access the source code with git clone wisielec.py command. To find out more, go to Github!

When you have cloned the .py file, go to the next step.

• Locate where the downloaded file is located. You may have to unpack it if you chose to download a ZIP file. After you find out the path to the .py file, open up the terminal (CTRL+ALT+T).

• You can write ls to find out in which directory you currently are. Use the cd command to get to the directory with the .py file in it. You can also use the command realpath wisielec.py to get the full path of the Python file.

• To make the script executable first, Write chmod a+x wisielec.py in the terminal.

• To run the program, write python3 wisielec.py or ./wisielec.py

Now you can finally play the game!

When you've successfully run the program, you should see the main menu:

Please make sure to follow the instructions displayed on the screen throughout the game.

If you want to play a new game, choose 1. If you want to exit the game, choose 2.

If you want to see the winners, choose 3.

• If you haven't won yet, the program will inform you that the list is empty. To get on the winners' list, you have to win a game.
• If you won before, you should see your name on the list.
• Then you will be asked if you want to start a new game. If you choose 1, a new game will start by asking you where do you want to get the word from. If you choose 2, the program will stop.

• Choose 1 if you want to get a word from your own .txt file.
• Choose 2 if you want to get a random word from the program.

• You can either write the full path to the file.
• Or use cd and ls commands to get to the file's directory. If you are in the same directory as the file, type only the name of the file.

After the program recognises your file, you can start guessing!

• It is worth mentioning that in the repository, there is a .txt file included. You can use it for the game!

Now, you need to enter one letter to check if it is in the word.

• If you guess correctly, you should see congratulations:

• However, if you guess wrong you will see Zgaduj dalej!.

• If you enter a letter which you have already guessed, you will see Już użyłeś tej litery! Wpisz nową! as well as a list of the letters that you have already tried.

• If you enter more than 1 letter, you will get a message saying Wpisz tylko jedną literę.

Continue to enter letters until you will see the complete world. The program will congratulate you on your win by printing Brawo! Wygrałeś!

• You can also guess by typing the whole word! If you guess right, you will win the game. If you guess wrong, you will see Wpisz tylko jedną literę.

Then, the program will ask you to enter your name to save it to the winners' list.

• If you have problems with guessing the right letters, you can always use a lifeline by typing pomoc. Then, the program will give you one of the letters that you need. You can use the lifeline as many times as you need.

The program will remind you about the lifeline if it notices that you are struggling with guessing the correct letters.

• You should remember that every time you are wrong, the game will add a portion of the hangman. You have 8 tries until the hangman is completed.

In the picture, the first stages of the hangman are being added:

• When the whole hangman is completed, the game is over and you lose. After your 8th wrong entry, the program will inform you that you lost and display the word that you haven't guessed.

• After every game, you will be asked if you want to play again. Choose 1 to play again or 2 to exit the game.

If you choose this option, you will have to select a language:

• Enter 1 to choose Polish, 2 to choose English or 3 to choose German.

After that, you will have to choose a category:

• Enter 1 to choose animals, 2 to choose fruit or 3 to choose jobs.

After you choose a category, you can start guessing! Good luck!

• The last thing you should know is that if you choose the wrong option by mistake, you can always go back by typing wstecz!