Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 111 lines (88 sloc) 3.658 kB
8cb2cf0 @eht16 Initial import
eht16 authored
1 Geany - A fast and lightweight IDE
2 ----------------------------------
3
4
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.
13
14
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
dca5b8a @eht16 added notice about the folding feature
eht16 authored
23 - folding
8cb2cf0 @eht16 Initial import
eht16 authored
24 - many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal
25 - symbol lists
b3ddbe0 @eht16 added section for Win32 users
eht16 authored
26 - embedded terminal emulation
8cb2cf0 @eht16 Initial import
eht16 authored
27
28
29 Requirements
30 ------------
a23e999 @codebrainz Bump GTK+ version to 2.16
codebrainz authored
31 For compiling Geany yourself, you will need the GTK (>= 2.16.0)
dac3d64 @eht16 More GTK 2.8 => GTK 2.12 transition.
eht16 authored
32 libraries and header files. You will also need its dependency libraries
33 and header files, such as Pango, Glib and ATK. All these files are
34 available at http://www.gtk.org.
8cb2cf0 @eht16 Initial import
eht16 authored
35
265026b @ntrel Reformat text width with fmt. Add note about the HACKING file.
ntrel authored
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.
8cb2cf0 @eht16 Initial import
eht16 authored
39
40
41 Installation
42 ------------
43 Installing Geany is done by the following three commands:
44 $ ./configure
45 $ make
075fae6 @ntrel See the manual for details.
ntrel authored
46 (as root)
47 % make install
8cb2cf0 @eht16 Initial import
eht16 authored
48
49 For more configuration details run
50 $ ./configure --help
51
265026b @ntrel Reformat text width with fmt. Add note about the HACKING file.
ntrel authored
52 If there are any errors during compilation, check your build environment
075fae6 @ntrel See the manual for details.
ntrel authored
53 and try to find the error, otherwise contact the mailing list or one of
54 the authors.
55
56 See the manual for details (geany.txt/geany.html).
8cb2cf0 @eht16 Initial import
eht16 authored
57
58
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.
265026b @ntrel Reformat text width with fmt. Add note about the HACKING file.
ntrel authored
67 The most important option probably is -c or --config, where you can
68 specify an alternate configuration directory.
8cb2cf0 @eht16 Initial import
eht16 authored
69
70
b3ddbe0 @eht16 added section for Win32 users
eht16 authored
71 Windows
72 -------
265026b @ntrel Reformat text width with fmt. Add note about the HACKING file.
ntrel authored
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:
ce8102c @eht16 Add -lshfolder to linker flags on Windows. Add notice for Win9x users…
eht16 authored
76 - build support (implemented but might be still buggy)
b3ddbe0 @eht16 added section for Win32 users
eht16 authored
77 - embedded terminal emulation (VTE)
ce8102c @eht16 Add -lshfolder to linker flags on Windows. Add notice for Win9x users…
eht16 authored
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.
b3ddbe0 @eht16 added section for Win32 users
eht16 authored
82
83
3659643 @eht16 Added license notice Scintilla.
eht16 authored
84 License
85 -------
265026b @ntrel Reformat text width with fmt. Add note about the HACKING file.
ntrel authored
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
3659643 @eht16 Added license notice Scintilla.
eht16 authored
90 program.
265026b @ntrel Reformat text width with fmt. Add note about the HACKING file.
ntrel authored
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.
3659643 @eht16 Added license notice Scintilla.
eht16 authored
94
95
8cb2cf0 @eht16 Initial import
eht16 authored
96 Ideas, questions, patches and bug reports
97 -----------------------------------------
f101e95 @eht16 New website address: www.geany.org.
eht16 authored
98 See http://www.geany.org/
8cb2cf0 @eht16 Initial import
eht16 authored
99 If you add something, or fix a bug, please send a patch (in 'diff -u'
265026b @ntrel Reformat text width with fmt. Add note about the HACKING file.
ntrel authored
100 format) to the mailing list or one of the authors. Also see the HACKING
101 file.
8cb2cf0 @eht16 Initial import
eht16 authored
102
103
104 --
1c2c455 @b4n Update copyright information
b4n authored
105 2005-2012 by Enrico Tröger, Nick Treleaven, Colomban Wendling, Matthew Brush and Frank Lanitz
e320106 @eht16 Update copyright information and change format of email addresses in …
eht16 authored
106 enrico(dot)troeger(at)uvena(dot)de
eec5a83 @eht16 Change format of email addresses.
eht16 authored
107 nick(dot)treleaven(at)btinternet(dot)com
84da9b9 @eht16 Welcome Colomban Wendling, a new Geany developer.
eht16 authored
108 lists(dot)ban(at)herbesfolles(dot)org
8bf9a7c @b4n Add Matthew Brush as developer
b4n authored
109 mbrush(at)codebrainz(dot)ca
eec5a83 @eht16 Change format of email addresses.
eht16 authored
110 frank(at)frank(dot)uvena(dot)de
Something went wrong with that request. Please try again.