Commit 3a4a9008 authored by Julian Trischler's avatar Julian Trischler

Renamed README to README.rst and expanded it

* Added Installation sections in README.rst
* Added Makefile to generate HTML version of README.rst
parent 87c7c571
......@@ -6,3 +6,4 @@
*.pyo
boydl.index
README.html
doc:
rst2html -gdts README.rst > README.html
===================================
boydl -- Best Of YouTube DownLoader
===================================
This script will download all newly available videos using the Python
script ``youtube-dl.py`` it can find in the bestofyoutube.com RSS feed. An
index is used to remember already downloaded videos, so only new clips are
processed.
Written by Lyse <software@lyse.isobeef.org>, published under WTF PL.
==================================
boydl – Best Of YouTube DownLoader
==================================
**boydl** is a Bash script to download all newly available videos using
the Python script **youtube-dl** it can find in the *bestofyoutube.com*
RSS feed. An index is used to remember already downloaded videos, so only
new clips are processed.
Written by Lysander Trischler <software@lyse.isobeef.org> and published
under terms of WTF PL.
Installation
============
Setting up **boydl** is really simple. Just follow these steps.
youtube-dl
----------
Because **boydl** uses **youtube-dl** to process video downloads, you
need to get this project: http://rg3.github.com/youtube-dl/
Put the ``youtube-dl`` main Python script in your ``PATH`` and you'll be
done.
boydl
-----
Get with git
++++++++++++
The preferred way of obtaining **boydl** is via the official IsoBeef Git
Repository and ``git clone https://git.isobeef.org/boydl.git``. Of course
you must have **git** installed, to do so.
Get with direct download
++++++++++++++++++++++++
For those who haven't installed **git** we provide a much less conveniet
method to get **boydl**. Browse the web git interface and visit
https://git.isobeef.org/?p=boydl.git;a=blob;f=boydl to copy the file's
contents and save it on your disk.
Configuration
+++++++++++++
To set up **boydl** just put the ``boydl`` main Bash script it in your
``PATH``.
If you're a *bestofyoutube.com* user, you may want to ignore your already
viewed videos. To accomplish this ``cd`` into your **boydl** directory and
run ``boydl --html-urls > boydl.index``. This will put all videos into
your index file, so **boydl** thinks they were already downloaded
successfully and don't processes them anymore.
**Beware of the following pitfall:** *Don't* create a symbolic link in
``/usr/local/bin`` to ``boydl``, beacuse **boydl** then assumes your index
file is located in the very same directory, too, which isn't true in most
cases. (You also don't have write permissions here, if your system is
configured properly. The index file should be updated after a successfully
downloaded clip, so this won't work.) The recommended way is putting the
**boydl** directory into your ``PATH`` as mentioned above or create an
alias to the **boydl** executable in your shell configuration (e.g.
``~/.zshrc`` or ``~/.bashrc``).
You may want to customize your downloaded video filenames. You can do this
in the ``boydl`` Bash script, simply adjust the ``YOUTUBE_DL_PY_COMMAND``
variable at the very top of the script. Read **youtube-dl** documentation
to get an idea of what can be done.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment