Consider the files reload a project reloading, so it takes the lock and everything.
[kdevelop:agateau-kdevelop.git] / INSTALL
1 NOTE: This is a copy of a page in our Wiki, please consult it for the most
2 recent version of this document. See:
3 http://www.kdevelop.org/mediawiki/index.php?title=KDevelop_4/compiling&action=edit
4
5 The way to download, compile, install and run KDevelop depends on how you want
6 to download it and where do you want to install it to.
7 So follow the step by step instructions below.
8
9 == 1. Get the requirements ==
10 :Make sure to install the required KDE development packages, see
11 http://www.kdevelop.org/mediawiki/index.php/KDevelop_4/requirements
12 for a list of requirements.
13 In particular make sure to install KDE4 kdelibs development packages:
14 kdelibs-devel, kdeworkspace-devel (or build from sources).
15
16 :'''WARNING:''' You have to remove all KDevelop/KDevplatform/Sublime packages
17 provided by your distribution. If you don't do that, binary compatibility issues
18 will eventually lead to crashes and undefined behavior. To make sure, you can
19 search for KDevelop libraries with this command:
20
21 :<pre>find /usr/ -type f -name "*kdev*.so*"</pre>
22
23 :If no results are returned, you should be on the safe side.
24
25 == 2. Get the sources (assumes ''$HOME/src'' but you can replace it with
26 something else) ==
27 * By downloading it to ''$HOME/src''
28 **  download ''kdevplatform.tar.bz2'' and ''kdevelop.tar.bz2'' from
29 http://download.kde.org/download.php?url=unstable/kdevelop/
30 **  unpack them:
31         cd $HOME/src
32         tar xvjf kdevplatform.tar.bz2
33         tar xvjf kdevelop.tar.bz2
34
35 * '''Or''', by getting the latest sources directly out of the SVN server
36         svn co svn://anonsvn.kde.org/home/kde/trunk/extragear/sdk/kdevplatform $HOME/src/kdevplatform
37         svn co svn://anonsvn.kde.org/home/kde/trunk/extragear/sdk/kdevelop $HOME/src/kdevelop
38
39 == 3. Configure and install KDevPlatform ==
40
41 ::In both cases you need set the KDEDIRS environment variable to point to the
42 installation directory of both KDE4 and KDevPlatform.
43 ::This will tell KDE core components where to search for plugins and other data
44 related to KDE apps and contains just a list of paths (aka prefixes) where KDE
45 libraries and/or applications have been installed.
46 ::Assuming that you have the KDE4 libraries installed in ''/usr'' (these are
47 often from packages and installed in ''/usr'' or ''/opt/kde'' and is distro
48 specific, if unsure ask your distro where it is), you'll have to append it to
49 the KDEDIRS below.
50
51 * To be installed with the system libraries (you '''need root permissions''' to
52 do this)
53         mkdir -p $HOME/src/kdevplatform/build
54         cd $HOME/src/kdevplatform/build
55         cmake ../
56         make
57         sudo make install
58         export KDEDIRS=/usr/local:/usr
59         kbuildsycoca4
60 * '''Or''', to be installed locally on ''$HOME/kdevelop4'' but you can replace
61 it with something else (you do '''not need root permissions''' to do this)
62         mkdir -p $HOME/src/kdevplatform/build
63         cd $HOME/src/kdevplatform/build
64         cmake -DCMAKE_INSTALL_PREFIX=$HOME/kdevelop4 ../
65         make
66         make install
67         export KDEDIRS=$HOME/kdevelop4:/usr
68         kbuildsycoca4
69
70 == 4. Configure and install KDevelop ==
71 * To be installed with the system libraries (you '''need root permissions''' to
72 do this)
73         mkdir -p $HOME/src/kdevelop/build
74         cd $HOME/src/kdevelop/build
75         cmake ../
76         make
77         sudo make install
78         kbuildsycoca4
79 * '''Or''', to be installed locally on ''$HOME/kdevelop4'' but you can replace
80 it with something else (you do '''not need root permissions''' to do this)
81         mkdir -p $HOME/src/kdevelop/build
82         cd $HOME/src/kdevelop/build
83         cmake -DCMAKE_PREFIX_PATH=$HOME/kdevelop4 -DCMAKE_INSTALL_PREFIX=$HOME/kdevelop4 ../
84         make
85         make install
86
87 ::In this case you need set the KDEDIRS environment variable to point to the
88 installation directory of both KDE4, KDevPlatform and KDevelop.
89
90 ::This will tell KDE core components where to search for plugins and other data
91 related to KDE apps and contains just a list of paths (aka prefixes) where KDE
92 libraries and/or applications have been installed.
93
94 ::Assuming that you have the KDE4 libraries installed in ''/usr'' (these are
95 often from packages and installed in ''/usr'' or ''/opt/kde'' and is distro
96 specific, if unsure ask your distro where it is) and that you want to install
97 KDevelop4 into ''$HOME/kdevelop4'' then you need to:
98
99         export KDEDIRS=$HOME/kdevelop4:/usr
100         kbuildsycoca4
101
102 == 5. Get and install plugins (optional) ==
103
104 If you need extra functionality, you can get and install additional plugins for
105 KDevelop4 at [[KDevelop 4/compiling/plugins]].
106
107
108 == 7. Run KDevelop ==
109 * If installed in the system
110         kdevelop
111 * '''Or''', if installed in ''$HOME/kdevelop4'' local directory
112         $HOME/kdevelop4/bin/kdevelop
113
114 This assumes you’re running KDevelop4 from a terminal and not via the run dialog
115 or via a menu entry, if you want that to work you need to find out how to set
116 environment for the whole X11 session – thats usually distro-specific.
117
118 == 8. Contact the development team, or report bugs or wishes ==
119 :If you find any compile problems with KDevelop4 please don't report them on
120 bugs.kde.org, please report them on our
121 [http://www.kdevelop.org/index.html?filename=mailinglist.html developer
122 mailing-list] instead.
123
124 :The [http://bugs.kde.org/ bugzilla bug database] is only for bugs, and
125 '''not''' for compilation issues.
126
127 == 9. Keeping it up-to-date with the latest fixes ==
128 :If you got the sources from SVN on step 2. then you can update by issuing the
129 following commands:
130 * with '''root permissions''' do this
131         cd $HOME/src/kdevelop/build && sudo make uninstall
132         cd $HOME/src/kdevplatform/build && sudo make uninstall
133         svn up .. && make && sudo make install
134         kbuildsycoca4
135         cd $HOME/src/kdevelop/build
136         svn up .. && make && sudo make install
137         kbuildsycoca4
138 * '''Or''' if installed in local directory
139         cd $HOME/src/kdevelop/build && make uninstall
140         cd $HOME/src/kdevplatform/build && make uninstall
141         svn up .. && make && make install
142         kbuildsycoca4
143         cd $HOME/src/kdevelop/build
144         svn up .. && make && make install
145         kbuildsycoca4
146
147 You can also see the
148 [http://www.kdevelop.org/index.html?filename=4.0/ChangeLog_kdevplatform.html
149 latest changes and bug fixes of KDevPlatform] and the
150 [http://www.kdevelop.org/index.html?filename=4.0/ChangeLog.html latest changes
151 and fixes of KDevelop] on-line, updated every hour.