moved kdeaccessibility kdeaddons kdeadmin kdeartwork kdebindings kdeedu kdegames...
[kdeedu.git] / kturtle / README
blobb11066b2fce57f3c594968ecd7cc734a446e7748
1 Hi,
3 you are reading the README of the 'KTurtle' project that is initiated
4 and maintained by Cies Breijs (cies-AT-showroommama-DOT-nl). In this
5 README I will tell you how to get KTurtle running on your computer.
9 1. Requirements
10 You need to have KDE 3.2 or higher. I don't know if it will work with different
11 KDE versions since I did not test it. If it does not work please see
12 the Questions section below.
16 2. Compiling
17 The simplest way to compile this package is:
19   1) `cd' to the directory containing the package's source code and type
20      `./configure --prefix=<PATH>' to configure the package for your
21      system.
22      
23      Make sure to replace <PATH> by the path wher your KDE apps are
24      installed. This is mostly '/usr', but sometimes (for SuSE) '/opt/kde'.
25      If you dont know what to do try: `./configure --prefix=/usr'. If you don't give a --prefix the default path /usr/local will be used, resulting that KTurtle will no be with your other apps, and may not run smoothly.
27      Running `configure' takes a while.  While running, it prints some
28      messages telling which features it is checking for. If the
29      configure script exits with an error it will probably hint you
30      what it needs in order to succeed.
32   2) Type `make' to compile the package.
33      
34      'make' also takes a while, and it also has the possibility to exit
35      with errors. Although the errors messages 'make' produces are mostly
36      not as clear as the error messages from 'configure', they are a hint
37      to what went wrong. Please see the Questions section below if you
38      dont know what to do with these messages.
40 If it succeeded a binary named 'kturtle' is made and can be find in the
41 'src' directory within the directory containing the package's source
42 code.
44 Before you can run KTurtle you need to install it.
46      
47      
48 3. Installing     
49 NOTE: you often need 'root' privilliges to do the following! 
51   1) Type `make install' to install the programs and any data files and
52      documentation.
54   2) You can remove the program binaries and object files from the
55      source code directory by typing `make clean'. 
56      
57 If you want to uninstall KTurtle you should type 'make uninstall' when
58 in the source code directory.
60 Please note that 'make install' will install KTurtle to the path that is provided to the './configure' command with the '--prefix' flag! 
63 4. Running
64 Under normal circumstances should be able to run KTurtle from the
65 commandline by typing 'kturtle'.
67 If it does not work please go to the source code directory of KTurtle
68 and type:
70      cd src
71      ./kturlte
73 If this does not work please follow instuction form the Question section.
77 5. Questions
78 Check out the FAQ in the source code directory of KTurtle to see if your
79 question has allready been asked.
81 You can also mail questions to the mail address you find in the
82 beginning of this document. Or visit the KTurtle website:
83 http://kturlte.sf.net ,   or    http://edu.kde.org/kturtle
84 and post it in the forum.
88 Thanks for reading!
90 Cies.