cc::file: Remove unused macro definition
[cclive.git] / README
blob38f9e699163a64051a1aa0ff44bb6e2de8d031d9
1 General
2 =======
4 cclive is a tool for downloading media from YouTube and similar
5 websites. It has a low memory footprint compared to other existing
6 tools.
8 Home  : http://cclive.sourceforge.net/
9 gitweb: http://repo.or.cz/w/cclive.git
11 Installation
12 ============
14 Notes
15 -----
17 * This document does not cover how to use GNU Autotools for building
18   and installing software, instead, refer to the GNU Autotools
19   documentation, the INSTALL file and the "configure --help" output for
20   more information.
22 * If you're not familiar with GNU Autotools and/or installing software
23   from the source code, you may prefer to install cclive using a binary
24   package, instead. You can find cclive packaged for many distros
25   already.
27 * If you have previously installed cclive from the source code to your
28   system, the recommended practice is to uninstall the previous
29   installation first, before you continue with the new one. You would,
30   typically, run "make uninstall" (as root if necessary) from the same
31   directory you ran "make install" from.
33 * If you are building cclive from the git repository code, run the
34   `bootstrap.sh' first. This generates the configuration files. See also
35   the -h output for any additional info.
38 Simple install procedure
39 ------------------------
41   % ./configure && make
43   [ Become root if necessary ]
44   % make install
46 The configure script supports also the following options which are
47 relevant to the installation:
49   --with(out)-manual
50     Install the manual page for cclive
52   --(enable|disable)-ccl (default:yes)
53     Make a symbolic link from 'cclive' (executable) to 'ccl'.
56 Requirements
57 ------------
59 * libquvi 0.4
60   http://quvi.sourceforge.net/
61     $ sudo aptitude install libquvi-dev
63 * libpcre 8.02
64   http://pcre.org
65     $ sudo aptitude install libpcre3-dev
67 * libboost 1.49.0
68   http://www.boost.org/
69     $ sudo aptitude install libboost-program-options-dev libboost-system-dev \
70                             libboost-filesystem-dev libboost-iostreams-dev \
71                             libboost-date-time-dev
73 * libcurl 7.20.0
74   http://curl.haxx.se/
75     $ sudo aptitude install libcurl4-gnutls-dev
76        (or libcurl4-openssl-dev)
78 * glibmm 2.24.2
79   http://library.gnome.org/devel/glibmm/
80     $ sudo aptitude install libglibmm-2.4-dev
82 * GLib 2.24.2
83   http://library.gnome.org/devel/glib/
84     $ sudo aptitude install libglib2.0-dev
86 * pkg-config for tracking the compilation flags needed for libraries
87   http://www.freedesktop.org/software/pkgconfig/
88     $ sudo aptitude install build-essential
90 * GNU make is recommended
91   http://www.gnu.org/software/make/
92     $ sudo aptitude install build-essential
95 How to report bugs
96 ==================
98 Please see: http://cclive.sourceforge.net/#bugs
101 Patches
102 =======
104 Please see: http://cclive.sourceforge.net/contrib/
107 License
108 =======
110 cclive is Free Software, licensed under the GNU Affero GPLv3+.