Warn about preprocessor testing GEANY_API_VERSION below 200 because
[geany-mirror.git] / README
blob2ffca6b34ad9c2a547681c0ab44982d0fa00bb50
1 Geany - A fast and lightweight IDE
2 ----------------------------------
5 About
6 -----
7 Geany is a small and lightweight integrated development environment.
8 It was developed to provide a small and fast IDE, which has only a
9 few dependencies from other packages. Another goal was to be as independent
10 as possible from a special Desktop Environment like KDE or GNOME. So it
11 is using only the GTK2 toolkit and therefore you need only the
12 GTK2 runtime libraries to run Geany.
15 Features
16 --------
17 The basic features of Geany are:
18 - syntax highlighting
19 - code completion
20 - auto completion of often used constructs like if, for and while
21 - auto completion of XML and HTML tags
22 - call tips
23 - folding
24 - many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal
25 - symbol lists
26 - embedded terminal emulation
29 Requirements
30 ------------
31 For compiling Geany yourself, you will need the GTK (>= 2.8.0) libraries
32 and header files. You will also need its dependency libraries and header
33 files, such as Pango, Glib and ATK. All these files are available at
34 http://www.gtk.org.
36 Furthermore you need, of course, a C compiler and the Make tool; a C++
37 compiler is also needed for the required Scintilla library included. The
38 GNU versions of these tools are recommended.
41 Installation
42 ------------
43 Installing Geany is done by the following three commands:
44 $ ./configure
45 $ make
46 (as root)
47 % make install
49 For more configuration details run
50 $ ./configure --help
52 If there are any errors during compilation, check your build environment
53 and try to find the error, otherwise contact the mailing list or one of
54 the authors.
56 See the manual for details (geany.txt/geany.html).
59 Usage
60 -----
61 To run Geany just type
62 $ geany
63 on a console or use the applications menu from your desktop environment.
64 There a few command line options. See the manual page of Geany or run
65 $ geany --help
66 for details. Or look into the documention in the doc/ directory.
67 The most important option probably is -c or --config, where you can
68 specify an alternate configuration directory.
71 Windows
72 -------
73 Geany runs also under Windows. To download the binary with all necessary
74 files, visit Geany's homepage. But you should know, that the Windows
75 version is not yet well tested and there are some features missing:
76 - build support (implemented but might be still buggy)
77 - embedded terminal emulation (VTE)
78 - Windows 9x users: in order to run Geany on Windows 95, 98 or ME you
79   need to install the file SHFolder.dll either in the Geany installation
80   directory or in your Windows directory. For more information please
81   visit http://support.microsoft.com/kb/241733.
84 License
85 -------
86 Geany is distributed under the terms of the GNU General Public License
87 as published by the Free Software Foundation; either version 2 of the
88 License, or (at your option) any later version.  A copy of this license
89 can be found in the file COPYING included with the source code of this
90 program.
91 The included Scintilla library (found in the subdirectory scintilla/)
92 has its own license, which can be found in the file scintilla/License.txt
93 included with the source code of this program.
96 Ideas, questions, patches and bug reports
97 -----------------------------------------
98 See http://www.geany.org/
99 If you add something, or fix a bug, please send a patch (in 'diff -u'
100 format) to the mailing list or one of the authors. Also see the HACKING
101 file.
105 2005-2010 by Enrico Tröger, Nick Treleaven and Frank Lanitz
106 enrico(dot)troeger(at)uvena(dot)de
107 nick(dot)treleaven(at)btinternet(dot)com
108 frank(at)frank(dot)uvena(dot)de