Browse Source

README: add note about config file

Also:
- update usage message
- kaabot.py: update description (period needed after the description,
  because of ConfigArgParse automatic message).
Matteo Cypriani 2 years ago
parent
commit
43e04dc62d
2 changed files with 6 additions and 4 deletions
  1. 5
    3
      README.md
  2. 1
    1
      kaabot.py

+ 5
- 3
README.md View File

@@ -29,6 +29,9 @@ mkdir $HOME/.config/kaabot
29 29
 cp vocabulary.json $HOME/.config/kaabot
30 30
 ```
31 31
 
32
+If no configuration file exists, one will be created automatically (typically
33
+in `$HOME/.config/kaabot/config`) when KaaBot is launched for the first time.
34
+
32 35
 Usage
33 36
 -----
34 37
 
@@ -40,7 +43,7 @@ optional arguments:
40 43
   -h, --help            show this help message and exit
41 44
   -d, --debug           set logging to DEBUG
42 45
   -b DATABASE, --database DATABASE
43
-                        path to an alternative database; the "{muc}" string in
46
+                        path to an alternative database; the '{muc}' string in
44 47
                         the name will be substituted with the MUC's name as
45 48
                         provided by the --muc option
46 49
   -j JID, --jid JID     JID to use
@@ -48,9 +51,8 @@ optional arguments:
48 51
                         password to use
49 52
   -m MUC, --muc MUC     Multi User Chatroom to join
50 53
   -n NICK, --nick NICK  nickname to use in the chatroom (default: KaaBot)
51
-  -V VOCABULARY_FILE, --vocabulary VOCABULARY_FILE
54
+  -V VOCABULARY_FILE, --vocabulary_file VOCABULARY_FILE
52 55
                         path to an alternative vocabulary file
53
-                        
54 56
 ```
55 57
 
56 58
 License

+ 1
- 1
kaabot.py View File

@@ -385,7 +385,7 @@ if __name__ == '__main__':
385 385
     config_file = os.path.join(config_dir, 'config')
386 386
 
387 387
     argp = configargparse.ArgParser(default_config_files=[config_file],
388
-        description="Super Simple Silly Bot for Jabber")
388
+        description="Super Simple Silly Bot for Jabber.")
389 389
     argp.add_argument('-d', '--debug', help="set logging to DEBUG",
390 390
                       action='store_const',
391 391
                       dest='debug', const=logging.DEBUG,

Loading…
Cancel
Save