📝 update README

bad-apple-lab · Jan 19, 2024 · a71669d · a71669d
1 parent 9798008
commit a71669d
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -33,24 +33,24 @@ python -m badapple
 ```markdown
 usage: badapple [options] ... 
 
-BadApple-Python-OS-ISA-v0.0.5
+BadApple-Python-OS-ISA-v0.0.6
 
 options:
   -h, --help            show this help message and exit
-  --help_audio          show avaliable players
+  --help_audio          show avaliable players (default: False)
   -i INPUT, --input INPUT
-                        video file (use _BA_MP4 or _BA_BA to load built-in video)
+                        video file (use _BA_MP4 or _BA_BA to load built-in video) (default: _BA_MP4)
   -o OUTPUT, --output OUTPUT
-                        preload output file
-  --font FONT           font data file
-  --audio AUDIO         audio file (use _BA_WAV, _BA_MP3 or _BA_MP4 to load built-in audio)
+                        preload output file (default: )
+  --font FONT           font data file (default: )
+  --audio AUDIO         audio file (use _BA_WAV, _BA_MP3 or _BA_MP4 to load built-in audio) (default: )
   --audio_player AUDIO_PLAYER
-                        audio player [ffplay mpv vlc mpg123 cmus simpleaudio pyaudio playsound pydub auto]
+                        audio player [ffplay mpv vlc mpg123 cmus simpleaudio pyaudio playsound auto] (default: )
   -s SCALE, --scale SCALE
-                        width:height
-  -r RATE, --rate RATE  frame rate
-  --not_clear           not clear screen (with ANSI) before each frame
-  --contrast            contrast enhancement
-  --preload             preload video (not play)
-  --debug               debug
+                        width:height (0 means auto) (default: 0:0)
+  -r RATE, --rate RATE  frame rate (default: 1024.0)
+  --not_clear           not clear screen (with ANSI) before each frame (default: False)
+  --contrast            contrast enhancement (default: False)
+  --preload             preload video (not play) (default: False)
+  --debug               debug (default: False)
 ```
diff --git a/README.rst b/README.rst
@@ -39,23 +39,23 @@ Help Message
 
     usage: badapple [options] ... 
 
-    BadApple-Python-OS-ISA-v0.0.5
+    BadApple-Python-OS-ISA-v0.0.6
 
     options:
       -h, --help            show this help message and exit
-      --help_audio          show avaliable players
+      --help_audio          show avaliable players (default: False)
       -i INPUT, --input INPUT
-                            video file (use _BA_MP4 or _BA_BA to load built-in video)
+                            video file (use _BA_MP4 or _BA_BA to load built-in video) (default: _BA_MP4)
       -o OUTPUT, --output OUTPUT
-                            preload output file
-      --font FONT           font data file
-      --audio AUDIO         audio file (use _BA_WAV, _BA_MP3 or _BA_MP4 to load built-in audio)
+                            preload output file (default: )
+      --font FONT           font data file (default: )
+      --audio AUDIO         audio file (use _BA_WAV, _BA_MP3 or _BA_MP4 to load built-in audio) (default: )
       --audio_player AUDIO_PLAYER
-                            audio player [ffplay mpv vlc mpg123 cmus simpleaudio pyaudio playsound pydub auto]
+                            audio player [ffplay mpv vlc mpg123 cmus simpleaudio pyaudio playsound auto] (default: )
       -s SCALE, --scale SCALE
-                            width:height
-      -r RATE, --rate RATE  frame rate
-      --not_clear           not clear screen (with ANSI) before each frame
-      --contrast            contrast enhancement
-      --preload             preload video (not play)
-      --debug               debug
+                            width:height (0 means auto) (default: 0:0)
+      -r RATE, --rate RATE  frame rate (default: 1024.0)
+      --not_clear           not clear screen (with ANSI) before each frame (default: False)
+      --contrast            contrast enhancement (default: False)
+      --preload             preload video (not play) (default: False)
+      --debug               debug (default: False)