Merge pull request #576 from Farama-Foundation/python-docs-update

A lot of documentation updates

README.md

@@ -6,7 +6,7 @@
 
 ViZDoom allows developing AI **bots that play Doom using only visual information** (the screen buffer). It is primarily intended for research in machine visual learning, and deep reinforcement learning, in particular.
 
-ViZDoom is based on [ZDoom](https://github.com/rheit/zdoom) to provide the game mechanics.
+ViZDoom is based on [ZDoom](https://zdoom.org) engine to provide the game mechanics.
 
 ![ViZDoom Demo](https://raw.githubusercontent.com/Farama-Foundation/ViZDoom/master/docs/_static/img/vizdoom-demo.gif)
 

docs/api/configurationFiles.md

@@ -3,7 +3,7 @@
 Instead of configuring the ViZDoom in code, you can load it from the configuration file(s). Each file is read sequentially, so multiple entries with the same key will overwrite previous entries.
 
 ## Format
-Each entry in a configraution file is a pair of **key** and **value** separated by an equal sign (**"="**). The file format should also abide the following rules:
+Each entry in a configraution file is a pair of **key** and **value** separated by an equal sign (**`=`**). The file format should also abide the following rules:
 
 * one entry per line (except for list parameters),
 * case insensitive
@@ -14,10 +14,10 @@ Each entry in a configraution file is a pair of **key** and **value** separated
 A violation of any of these rules will result in ignoring **only** the line with the error and sending a warning message to stderr ("WARNING! Loading config from: ...").
 
 ### List of values
-**available_buttons** and **available_game_variables** are special parameters, which use multiple values and instead of a single value they expect a list of values separated by whitespaces and enclosed within braces ("{" and "}"). The list can stretch throughout multiple lines as long as all values are separated from each other by whitespaces.
+**available_buttons** and **available_game_variables** are special parameters, which use multiple values and instead of a single value they expect a list of values separated by whitespaces and enclosed within braces (`{` and `}`). The list can stretch throughout multiple lines as long as all values are separated from each other by whitespaces.
 
 ### Appending values
-Each list assignment (**KEY = { VALUES }**)clears values specified for this key before (in other configuration files or in the code). That is why the **append operator(*KEY += { VALUES })** is available. This way you can more easily combine multiple configuration files and tinker in code.
+Each list assignment (**`KEY = { VALUES }`**)clears values specified for this key before (in other configuration files or in the code). That is why the **append operator (`KEY += { VALUES }`)** is available. This way you can more easily combine multiple configuration files and tinker in code.
 
 ### Supported configuration keys:
 * `audioBufferEnabled/audio_buffer_enabled`
@@ -27,8 +27,8 @@ Each list assignment (**KEY = { VALUES }**)clears values specified for this key
 * `automapMode/automap_mode`
 * `automapRenderTextures/automap_render_textures`
 * `automapRotate/automap_rotate`
-* `availableButtons/available_buttons` (list)
-* `availableGameVariables/available_game_variables` (list)
+* `availableButtons/available_buttons` (list of values)
+* `availableGameVariables/available_game_variables` (list of values)
 * `consoleEnabled/console_enabled`
 * `deathPenalty/death_penalty`
 * `depthBufferEnabled/depth_buffer_enabled`
@@ -64,8 +64,7 @@ Each list assignment (**KEY = { VALUES }**)clears values specified for this key
 * `ViZDoomPath/vizdoom_path`
 * `windowVisible/window_visible`
 
-
-See also: [`DoomGame`](DoomGame.md) for config keys and functions related to them.
+Config keys are also mentioned for related methods in the documentation for `DoomGame` class.
 
 
 ### Sample configuration file content:
@@ -114,4 +113,4 @@ mode = PLAYER
 doom_skill = 5
 ```
 
-Other examples of configuration files can be found in [https://github.com/Farama-Foundation/ViZDoom/tree/master/scenarios](https://github.com/Farama-Foundation/ViZDoom/tree/master/scenarios)
+Other examples of configuration files can be found in [scenarios](https://github.com/Farama-Foundation/ViZDoom/tree/master/scenarios) directory.