summary refs log tree commit diff homepage
path: root/README.rst
diff options
context:
space:
mode:
authorNguyễn Gia Phong <vn.mcsinyx@gmail.com>2018-02-14 22:26:52 +0700
committerNguyễn Gia Phong <vn.mcsinyx@gmail.com>2018-02-14 22:31:57 +0700
commite1db0393f9ccd3d45af2c0025f05d6fc67f87547 (patch)
tree2d4191b6eca8920320ebab229ac8f1a67f98fc15 /README.rst
parent8095bcab8df77ec3b2143daab5d9b87c3f14af76 (diff)
downloadbrutalmaze-0.5.2.tar.gz
Add CLI option to copy default config and link doc to wiki 0.5.2
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst17
1 files changed, 11 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index fac504a..c5c54f3 100644
--- a/README.rst
+++ b/README.rst
@@ -39,17 +39,22 @@ from Brutal Maze wiki.
 Configuration
 -------------
 
-Brutal Maze reads settings from both configuration file and command-line
-arguments. These settings are read in the following order:
+Brutal Maze supports both configuration file and command-line options.
+Apparently one can change settings for graphics and control in the config file
+and set graphics options using in CLI. These settings are read in the following
+order:
 
+0. Default configuration [0]_
 1. System-wide configuration file [1]_
 2. Local configuration file [1]_
 3. Manually set configuration file [2]_
-4. Command-line arguments [3]_
+4. Command-line arguments
 
 The later-read preferences will overide the previous ones.
 
+.. [0] This can be copied to desired location by ``brutalmaze --write-config
+   PATH``. ``brutalmaze --write-config`` alone will print the file to stdout.
 .. [1] These will be listed as fallback config in the help message
-   (``brutalmaze --help``).
-.. [2] This can be set using ``brutalmaze --config PATH``.
-.. [3] Listed in the help message.
+   (``brutalmaze --help``). See `wiki <https://github.com/McSinyx/brutalmaze/wiki/Configuration>`_
+   for more info.
+.. [2] If specified by ``brutalmaze --config PATH``.