Documentation

README.md

@@ -1,22 +1,22 @@
-**PyHoot**
+# PyHoot
 
-Kahoot clone based on Python, final project for Gvahim.
+*Kahoot clone based on Python, final project for Gvahim.*
 
 Warning:
 Python 2.7 must be installed on the system.
 if you don't have it have it, you can download it from here. [Link](https://www.python.org/ftp/python/2.7.13/python-2.7.13.msi)
 
 **When you install in `Customize Python 2.7.x`, make sure you click on `Add python.exe to Path` and then on `Will be installed on local hard drive`.**
 
-How to start the server:
+## How to start the server:
 
-If you are using windows (recommended for Windows users):
+###If you are using windows (recommended for Windows users):###
 
 Go to the PyHoot directory and click on `Start Server (Windows).bat` from the PyHoot Directory.
 It will start the server on your IP address with port 80, meaning that you can join the game from any device in the same network as your server by writing the address in the address line.
 If you don't know your own IP address you can see it on the third line on the window that will be opened.
 
-If you are using command line \ shell (recommended for experts and Linux users):
+###If you are using command line \ shell (recommended for experts and Linux users):###
 
 Start the command line or shell in your system and change the directory where you put the directory of files (named PyHoot).
 Write the next command in the command line \ shell:
@@ -28,6 +28,8 @@ This command will enable you to use different arguments than the default ones, y
 ```python -m PyHoot --[name of argument]=[the value of the arguement]```
 In this way, you'll be able to add as many arguments as you want.
 
+To shutdown the Robot use <kbd>CTRL</kbd> + <kbd>Break</kbd>
+
 Arguments list:
 
         -h, --help            show this help message and exit
@@ -43,21 +45,3 @@ Arguments list:
         --log-level {DEBUG,INFO,WARNING,CRITICAL,ERROR}
                             Log level
         --log-file FILE       Logfile to write to, otherwise will log to console.
-
-TODO:
-- [X] Make server send files
-- [X] Create XML class
-- [X] Quiz editor (independent)
-- [X] Add support to services
-- [X] Registrater players
-- [X] Show question on the screen and move to the next part (timer)
-- [X] Get answers and analyze them
-- [X] Update database of player with score
-- [X] Show answer
-- [X] Show leaderboard
-- [X] End of game
-- [X] XML only
-- [ ] CSS Day!
-- [X] Python Client Random Answer
-- [X] Python Client Fetch images
-- [ ] Hide\ Find string in picture