README

   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 GTK+ toolkit and therefore you need only the
  12 GTK+ 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
  23 - folding
  24 - many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal
  25 - symbol lists
  26 - embedded terminal emulation
  27
  28
  29 Requirements
  30 ------------
  31 For compiling Geany yourself, you will need the GTK2 (>= 2.24) or
  32 GTK3 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.
  35
  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.
  39
  40
  41 Installation
  42 ------------
  43 Installing Geany is done by the following three commands:
  44 $ ./configure
  45 $ make
  46 (as root)
  47 % make install
  48
  49 If you are building from a Git clone rather than a source tarball, you need
  50 to run ./autogen.sh first.
  51
  52 For more configuration details run
  53 $ ./configure --help
  54
  55 If there are any errors during compilation, check your build environment
  56 and try to find the error, otherwise contact the mailing list or one of
  57 the authors.
  58
  59 See the manual for details (geany.txt/geany.html).
  60
  61
  62 Usage
  63 -----
  64 To run Geany just type
  65 $ geany
  66 on a console or use the applications menu from your desktop environment.
  67 There a few command line options. See the manual page of Geany or run
  68 $ geany --help
  69 for details. Or look into the documentation in the doc/ directory.
  70 The most important option probably is -c or --config, where you can
  71 specify an alternate configuration directory.
  72
  73
  74 Windows
  75 -------
  76 Geany runs also under Windows. To download the binary with all necessary
  77 files, visit Geany's homepage. But you should know, that the Windows
  78 version is not yet well tested and there are some features missing:
  79 - build support (implemented but might be still buggy)
  80 - embedded terminal emulation (VTE)
  81 - Windows 9x users: in order to run Geany on Windows 95, 98 or ME you
  82   need to install the file SHFolder.dll either in the Geany installation
  83   directory or in your Windows directory. For more information please
  84   visit http://support.microsoft.com/kb/241733.
  85
  86
  87 License
  88 -------
  89 Geany is distributed under the terms of the GNU General Public License
  90 as published by the Free Software Foundation; either version 2 of the
  91 License, or (at your option) any later version.  A copy of this license
  92 can be found in the file COPYING included with the source code of this
  93 program.
  94 The included Scintilla library (found in the subdirectory scintilla/)
  95 has its own license, which can be found in the file scintilla/License.txt
  96 included with the source code of this program.
  97
  98
  99 Ideas, questions, patches and bug reports
 100 -----------------------------------------
 101 See http://www.geany.org/
 102 If you add something, or fix a bug, please send a patch (in 'diff -u'
 103 format) to the mailing list or one of the authors. Also see the HACKING
 104 file.
 105
 106
 107 --
 108 2005-2015 by Enrico Tröger, Nick Treleaven, Colomban Wendling, Matthew Brush and Frank Lanitz
 109 enrico(dot)troeger(at)uvena(dot)de
 110 nick(dot)treleaven(at)btinternet(dot)com
 111 lists(dot)ban(at)herbesfolles(dot)org
 112 mbrush(at)codebrainz(dot)ca
 113 frank(at)frank(dot)uvena(dot)de