Skip to content

Commit d21c62d

Browse files
committed
Update README and __main__ help description
1 parent c4e3183 commit d21c62d

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ The terminal-based implementation accepts several arguments, detailed here:
8181
usage: snakeng [-h] [-x WIDTH] [-y HEIGHT] [-s {slow,medium,fast,faster}]
8282
[-o OUTPUT_FILE] [-i INPUT_FILE] [-f FPS]
8383

84-
Simple terminal-based snake game showing how to use snakeng to implement a
85-
game
84+
Simple terminal-based snake game showing how to use snakeng. Use arrow keys to
85+
change snake direction, use 'p' to pause, and use 'Ctrl-C' to quit.
8686

8787
options:
8888
-h, --help show this help message and exit
@@ -96,7 +96,7 @@ The terminal-based implementation accepts several arguments, detailed here:
9696
size increases. (default: None)
9797
-o OUTPUT_FILE, --output-file OUTPUT_FILE
9898
If set, the game state will be saved to the specified
99-
filename (default: None)
99+
filename when you quit with Ctrl-C (default: None)
100100
-i INPUT_FILE, --input-file INPUT_FILE
101101
If set, the game state will be loaded from the
102102
specified filename (default: None)

snakeng/__main__.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ def process_frame(game, frame_time):
5454

5555
def main():
5656
parser = argparse.ArgumentParser(prog='snakeng',
57-
description='Simple terminal-based snake game showing how to use snakeng to implement a game',
57+
description="Simple terminal-based snake game showing how "
58+
"to use snakeng. Use arrow keys to change snake direction, "
59+
"use 'p' to pause, and use 'Ctrl-C' to quit.",
5860
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
5961

6062
parser.add_argument('-x', '--width', default=40, type=int, help='Game area width in characters')
@@ -63,7 +65,7 @@ def main():
6365
help='Sets the snake speed for the whole game. If unset, the snake speed will '
6466
'automatically increase as the snake size increases.')
6567
parser.add_argument('-o', '--output-file', default=None, type=str, help='If set, the game state will be'
66-
' saved to the specified filename')
68+
' saved to the specified filename when you quit with Ctrl-C')
6769
parser.add_argument('-i', '--input-file', default=None, type=str, help='If set, the game state will be'
6870
' loaded from the specified filename')
6971
parser.add_argument('-f', '--fps', default=24, type=int, help='Framerate in frames per second')

0 commit comments

Comments
 (0)