summaryrefslogtreecommitdiffstats
path: root/kapptemplate/README
blob: 9ee09553957d1c421d09fdf899525d561d015c3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
KAppTemplate v1.1
Kurt Granroth <granroth@kde.org>
----------------------------------------------------------------------

What is it?
-----------
KAppTemplate is a shell script that will create the necessary
framework to develop various KDE applications.  It takes care of the
autoconf/automake code as well as providing a skeleton and example of
what the code typically looks like.

Currently, KAppTemplate creates four different types of frameworks:

1) Full featured KDE application

   This is a "normal" KDE application with nearly every bleeding edge
   feature.

2) KPart application

   This creates a KDE application that uses KParts as both the Shell
   and the Part (KParts::MainWindow and KParts::ReadWritePart)

3) KPart plugin

   This creates a sample KPart plugin that acts on KHTMLPart

4) Existing application conversion

   This will take existing source and put it in a KDE automake/autoconf
   framework

What is a framework?
--------------------
When I say "framework", I mean all of the source files as well as the
autoconf/automake stuff.  When KAppTemplate is done, all you will need
to do to compile and install your app is:
    ./configure
    make && make install

What do I need to use this?
---------------------------
o KDE 3.x
o autoconf
o automake

How do I install it?
--------------------
If you have a standalone kapptemplate.tar.bz2, do:
  ./configure
  make && make install
If you are installing from kdesdk, then just
  make && make install
If you are installing from .deb or .rpm, then install like any other
normal package

How does <whatever> work?
-------------------------
Before you email me, look through the kapptemplate file.  It is a
shell script so it should be pretty easy to understand what is going
on.

I have a suggest, question, or comment
--------------------------------------
Well, email me, then!

Have fun!
Kurt Granroth <granroth@kde.org>