Add the tutorial (and tidy-up the README and index)

waveform80 · Jul 21, 2024 · 028f1d6 · 028f1d6
1 parent 9046764
commit 028f1d6
Show file tree

Hide file tree

Showing 3 changed files with 381 additions and 17 deletions.
diff --git a/README.rst b/README.rst
@@ -5,10 +5,10 @@ tvrip
 =====
 
 tvrip is a small command line script that brings together several other
-utilities (Handbrake, Atomic Parsley, GOCR, etc.) with the aim of making it
-relatively simple to rip whole seasons or series of TV episodes from DVD to
-high quality MP4s, along with optional subtitles, alternate languages and
-director's commentaries.
+utilities (Handbrake, Atomic Parsley, mkvtoolnix, VLC, etc.) with the aim of
+making it relatively simple to rip whole seasons or series of TV episodes from
+DVD to high quality MP4 or Matroska files, along with optional subtitles,
+alternate languages and director's commentaries.
 
 
 Pre-requisites

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,25 +3,17 @@ Welcome!
 ========
 
 tvrip is a small command line script that brings together several other
-utilities (Handbrake and Atomic Parsley etc.) with the aim of making it
-relatively simple to rip whole seasons or series of TV episodes from DVD to
-high quality MP4s, along with optional subtitles.
-
-Contents:
+utilities (Handbrake, Atomic Parsley, mkvtoolnix, VLC, etc.) with the aim of
+making it relatively simple to rip whole seasons or series of TV episodes from
+DVD to high quality MP4 or Matroska files, along with optional subtitles,
+alternate languages and director's commentaries.
 
 .. toctree::
    :maxdepth: 1
+   :hidden:
 
    install
    tutorial
    commands
    settings
    license
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
-