Recent: Reverse order to "most recent first"
[nomnom.git] / README
blob672e111394f591dfe736e28e2fcecc91342d6f86
3 NomNom
4 ===========
6 NomNom is an application for downloading videos from Youtube and other similar
7 video websites that require Adobe Flash to view the video content. Video
8 streaming or downloading can be started simply by dropping an URL onto the
9 application window.
11 NomNom relies on a number of different other programs: quvi(1) to parse the
12 video links, curl(1) to download the videos, and a media streaming capable
13 player software, such as vlc(1), to stream the media. NomNom is written in
14 C++ to use the Qt framework.
16 The name of the application refers to the sound effect that is made when
17 eating something tasty or nutritious.
19 WWW: <http://nomnom.sourceforge.net/>
20 GIT: <git://repo.or.cz/nomnom.git>
23 NOTES
25   * Configuration
27     Possibly the most difficult part of the application from a user's
28     point of view. We have hardcoded some of the typical values for
29     quvi(1), curl (1) and vlc(1) that NomNom uses as defaults to make
30     this easier.
31   
32   * System wide configuration
34     Packagers are encouraged to add a system wide configuration file
35     to their NomNom packages with typical settings to their distros.
36     Please read the "NOTES FOR PACKAGERS" in the INSTALL file.
39 GETTING STARTED
41   * Right-click on the window to open the context-menu
43   * Check the configuration (Preferences, Ctrl+E)
45     - Check the paths to quvi(1), curl(1) and player (e.g. vlc(1))
47       The default values should work on most systems out of the box.
48       Make any changes you see necessary.
50   * Drag and drop video page URLs from, for example, your web browser.
51   This starts the download (or streaming if selected).
53   * You can make NomNom stay on top of other windows (Preferences / Other).
54   This will make it easier to use NomNom if you have limited screen space.
56   * Nomnom resumes file transfers by default (determined by the curl command
57   in the Preferences). Check "Overwrite" in the context menu if you want to
58   overwrite the existing files.