[README] Add table of contents (Closes #4458)

[yt-dlp.git] / devscripts / prepare_manpage.py

from __future__ import unicode_literals

import io
import os.path
import sys
import re

ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
README_FILE = os.path.join(ROOT_DIR, 'README.md')

with io.open(README_FILE, encoding='utf-8') as f:
    readme = f.read()

PREFIX = '''%YOUTUBE-DL(1)

# NAME

youtube\-dl \- download videos from youtube.com or other video platforms

# SYNOPSIS

**youtube-dl** \[OPTIONS\] URL [URL...]

'''
readme = re.sub(r'(?s)^.*?(?=# DESCRIPTION)', '', readme)
readme = re.sub(r'\s+youtube-dl \[OPTIONS\] URL \[URL\.\.\.\]', '', readme)
readme = PREFIX + readme

if sys.version_info < (3, 0):
    print(readme.encode('utf-8'))
else:
    print(readme)