Commit dfa28b84 authored by Laurent Bachelier's avatar Laurent Bachelier 🐧

Better README/INSTALL

parent 70442b30
......@@ -56,3 +56,10 @@ For example, instead of running ``videoob -b youtube search plop``, you would
run::
$ ./tools/local_run.sh videoob -b youtube search plop
Bash completion
---------------
To enable bash completion, just source the ``tools/weboob_bash_completion``
file from your ``~/.bashrc`` file.
......@@ -3,28 +3,27 @@ Weboob is a project which provides a core library, modules and applications.
Overview
--------
The core library defines capabilities: features common to various websites. For
example, http://www.youtube.com and http://www.dailymotion.com are both videos
providers: Weboob defines the “ICapVideo” capability.
Each module interfaces a website and implements one or many of these
capabilities. modules can be configured, which means that the end-user can
provide personal information to access the underlaying website (login/password
for example).
Applications offer the ability to the end-user to work with many modules in
parallel, in a multi-threaded way. For example, one could search a video on
many providers websites. Applications are toolkit-agnostic. They can use Gtk,
Qt or text-only, more adapted to reuse data through pipes.
The core library provides base classes which help the developer to write
The core library defines capabilities: features common to various websites.
For example, http://www.youtube.com/ and http://www.dailymotion.com/ both
provide videos; Weboob defines the "ICapVideo" capability for them.
Each module interfaces with a website and implements one or many of these
capabilities. Modules can be configured (becoming a "backend"), which means
that the end-user can provide personal information to access the underlying
website, like a login and password.
Applications allow the end-user to work with many modules in parallel,
in a multi-threaded way. For example, one could search a video on
many websites at once. Applications are toolkit-agnostic. They can use GTK+,
Qt or be text-only. The latter can be used either in an interactive way
or in pipes.
The core library provides base classes which help developers write
modules and applications.
Weboob is written in Python and is distributed under the AGPLv3+ license.
Bash completion
---------------
For more information, please go to the official website at http://weboob.org/
To enable bash completion, just source the tools/weboob_bash_completion
file from your ~/.bash_completion file (which is sourced by /etc/bash_completion).
Installation is described on the website or in the INSTALL file.
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