summaryrefslogtreecommitdiffstats
path: root/Building-with-cmake.txt
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-02-10 03:05:17 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-02-10 03:05:17 +0000
commit2c945cd914550233ed352ff195afeb4dd793f122 (patch)
tree4796bfab5733942b90b5a66bb05655be5fdcca03 /Building-with-cmake.txt
downloadkile-2c945cd914550233ed352ff195afeb4dd793f122.tar.gz
kile-2c945cd914550233ed352ff195afeb4dd793f122.zip
Added abandoned KDE3 version of Kile
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/kile@1088055 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'Building-with-cmake.txt')
-rw-r--r--Building-with-cmake.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/Building-with-cmake.txt b/Building-with-cmake.txt
new file mode 100644
index 0000000..c91830e
--- /dev/null
+++ b/Building-with-cmake.txt
@@ -0,0 +1,51 @@
+CMake 2.4.4 (or later) is required to build Kile.
+
+Building Kile
+=============
+
+1. Get the Kile directory from trunk (there is no need to get the whole office
+module anymore).
+
+2. Create a "kile-build" directory somewhere for an out-of-source build.
+
+3. Enter the "kile-build" directory and call cmake with:
+
+ cmake <path to the kile directory> -DCMAKE_INSTALL_PREFIX=$HOME/.kde
+
+ to install Kile later on in the current user's home directory.
+
+4. In the "kile-build" directory, issue "make" to start the build process.
+ Issuing "make install" will start the installation process, for which the DESTDIR
+ option can be used to specify the base directory of the installed files.
+
+
+Building Documentation
+======================
+
+The documentation will automatically be built provided that the documentation files
+are located in the following directories:
+<kile-root>
+ /doc for the standard documentation and
+ accompanying image files
+
+ /translations
+ /<language>
+ /doc for the translated documentation and
+ images in language <language>
+
+ /messages for the translated message catalogs
+ in language <language>
+
+Please note that every docbook must be called "index.docbook" and that only PNG image
+files can be used. Furthermore, message catalogs must be called "kile.po".
+
+When the "doc" and "translations" directories are found, the build targets "docbooks"
+and "translations" will be generated for the compiling of the documentation.
+
+
+Special Flags
+=============
+
+The flag "KILE_VERSION" can be set in the CMake cache to specify the installation
+directory of basic documentation files (README, AUTHORS, ChangeLog,...), i.e. they
+will be installed in "share/doc/kile-${KILE_VERSION}/" instead of "share/doc/kile/". \ No newline at end of file