diff --git a/README.cmake b/README.cmake index 97f428aa..5cecb69d 100644 --- a/README.cmake +++ b/README.cmake @@ -13,5 +13,10 @@ Using CMake to build Conky is pretty easy, and here is how I do it: $ make # make install # if you want +There are a number of build options for Conky, and the best way to discover +them is to use the ccmake (or cmake-gui) CMake tool for browsing them. -NOTE: I haven't actually finished the CMake build system yet, because I'm lazy. I'll add all the different options eventually though. +Certain Conky build time features (such as doc generation) require third-party +applications, which you should be notified of via CMake. In the case of doc +generation, you'll need the docbook2X package (available on most +distributions). diff --git a/README.git-version b/README.git-version deleted file mode 100644 index 80cbddab..00000000 --- a/README.git-version +++ /dev/null @@ -1,45 +0,0 @@ -QUICK & EASY: - $ sh autogen.sh - $ ./configure - $ make - $ ./src/conky # to run Conky - # make install - -First, read the README. This contains instructions specific to building conky -fresh from the git repo: - -* Conky requires three "auto-tools", with at least the specific version numbers. - Make sure these are installed: - - aclocal-1.9 - automake-1.9 - autoconf-2.59 - -* NOTE: You may also need to install docbook2X for generating the - documentation. Conky will check for the following programs in PATH during - configuration: - - db2x_xsltproc - db2x_manxml - xsltproc - -* In the directory where you cloned conky from git, - run "aclocal", "automake", and then "autoconf". - Make sure you run those commands with the latest versions... - it is very possible that older versions are installed, and - plain "automake" really means automake-1.4, not what we want, - but "automake-1.9" instead. - Use the "--version" option to check the program version, i.e. - "autoconf --version". - - You can also try using the autogen.sh script, like so: - - $ sh autogen.sh - -* After that, it's the familiar - - $ ./configure - $ make - # make install - - You might have to do the last step as root. diff --git a/autogen.sh b/autogen.sh index 9cf7ea8c..aca9356d 100755 --- a/autogen.sh +++ b/autogen.sh @@ -26,6 +26,11 @@ # # optional $1 = optional directory containing build tree or git working copy +# Something exceptionally irritating to get people to move away from autotools. +echo +echo "\033[41m\033[34m The Conky autotools build system is now deprecated in favour of CMake. Please see README.cmake for usage instructions." +echo + AUTOCONF=${AUTOCONF:-autoconf} AUTOMAKE=${AUTOMAKE:-automake} ACLOCAL=${ACLOCAL:-aclocal} diff --git a/doc/docs.xml b/doc/docs.xml index 6a370648..c80f96d2 100644 --- a/doc/docs.xml +++ b/doc/docs.xml @@ -68,19 +68,18 @@ Compiling - For users compiling from source on a binary distro, - make sure you have the X development libraries installed - (Unless you provide configure with "--disable-x11"). This - should be a package along the lines of "libx11-dev" or - "xorg-x11-dev" for X11 libs, and similar "-dev" format for - the other libs required (depending on your configure - options). You should be able to see which extra packages - you need to install by reading errors that you get from - './configure'. You can enable/disable stuff by giving - options to configure, but be careful with disabling. For - example: with --disable-math you won't get errors but - logarithmic graphs will be normal graphs and gauges - will miss their line. + For users compiling from source on a binary distro, make sure you + have the X development libraries installed (Unless you configure + your build without X11). This should be a package along the lines + of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar "-dev" + format for the other libs required (depending on your build + options). You should be able to see which extra packages you need + to install by reading errors that you get from running `cmake'. The + easiest way to view the available build options is to run `ccmake' or + `cmake-gui' from the source tree, but be careful when disabling + certain features as you may lose desired functionality. E.g., + with BUILD_MATH disabled you won't get errors but logarithmic + graphs will be normal graphs and gauges will miss their line. Conky has (for some time) been available in the repositories of most popular distributions. Here are some @@ -94,35 +93,17 @@ repositories, and can be installed by doing "aptitude install conky". - Example to compile and run Conky with all optional - components (note that some configure options may differ for + Example to compile and run Conky with default + components (note that some build options may differ for your system): - + - - - - - - - - - + @@ -148,10 +129,12 @@ - Conky has been tested to be compatible with C99 C, - however it has not been tested with anything other than - gcc, and is not guaranteed to work with other - compilers. + Conky has been tested to be compatible with C99 C and C++0x C++, + however it has not been tested with anything other than gcc, and is + not guaranteed to work with other compilers. + + TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead of + just `cmake'.