Improve documentation

amotl · amotl · commit d3d920e7e493 · 2022-12-15T10:22:47.000+01:00
diff --git a/README.rst b/README.rst
@@ -23,6 +23,22 @@ Setup
 Usage
 *****
 
+::
+
+    python pygource.py \
+        --name "Project ACME" \
+        --path /path/to/acme \
+        --audio-source '/path/to/audio.mp3' \
+        --audio-loops 10
+
+
+********
+Examples
+********
+
+Common
+======
+
 Get an audio file::
 
     youtube-dl --extract-audio --format=m4a \
@@ -36,32 +52,42 @@ Convert it to MP3 format::
         -c:v copy -c:a libmp3lame -q:a 4 \
         "./var/Beastie boys - Suco De Tangerina.mp3"
 
-Get sources of repository::
+Gource
+======
+
+Acquire sources::
 
     git clone https://github.com/acaudwell/Gource ./var/Gource
 
-Invoke renderer and play video, example 1::
+Render and play video::
 
     python pygource.py \
-        --name Gource \
+        --name "Gource" \
         --path "./var/Gource" \
         --audio-source "./var/Beastie boys - Suco De Tangerina.mp3" \
-        --audio-loops 2
+        --audio-loops 10
 
     open -a vlc Gource.mp4
 
-Invoke renderer and play video, example 2::
+
+CrateDB
+=======
+
+Acquire sources::
+
+    git clone https://github.com/crate/crate ./var/crate
+
+Render and play video::
 
     python pygource.py \
-        --name "CrateDB 2022Q1" \
-        --path ~/dev/crate/sources/crate \
+        --name "CrateDB 2022H2" \
+        --path ./var/crate \
         --audio-source "./var/Beastie boys - Suco De Tangerina.mp3" \
         --audio-loops 10 \
         --outdir "./var" \
         --overwrite
 
-    # --time-lapse \
+    open -a vlc "./var/CrateDB 2022H2.mp4"
 
-    open -a vlc "./var/CrateDB 2022Q1.mp4"
 
 .. _Gource: https://github.com/acaudwell/Gource
diff --git a/backlog.rst b/backlog.rst
@@ -2,4 +2,6 @@
 PyGource backlog
 ################
 
+- [o] Add ``--start-date`` and ``--stop-date`` options.
 - [o] Better ``--time-lapse`` option.
+- [o] Make option ``--audio-loops`` obsolete.
diff --git a/pygource.py b/pygource.py
@@ -1,5 +1,5 @@
 """
-Renders video of repository commit history using gource, adds background song.
+Render video of VCS repository commit history using Gource, with audio.
 
 Prerequisites::
 
@@ -11,7 +11,7 @@
         --name acme-trunk \
         --path ~/dev/three-investigators/acme/trunk \
         --audio-source '/home/foobar/music/Beastie boys/Suco De Tangerina.mp3' \
-        --audio-loops 50 \
+        --audio-loops 10 \
         # --overwrite
 """
 import os
@@ -253,17 +253,7 @@ def run(self):
         shutil.move(tmpfile, self.video_file)
 
 
-def render_single():
-    """
-    Renders single projects' vcs repository, e.g.::
-
-        bin/gource-render-single \
-            --name acme-trunk \
-            --path ~/dev/three-investigators/acme/trunk \
-            --audio-source '/home/foobar/music/Beastie boys/Suco De Tangerina.mp3' \
-            --audio-loops 50 \
-            # --overwrite
-    """
+def render():
 
     from optparse import OptionParser
 
@@ -318,4 +308,4 @@ def render_single():
 
 
 if __name__ == "__main__":
-    render_single()
+    render()
