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
  19 - syntax highlighting
  20 - code completion
  21 - auto completion of often used constructs like if, for and while
  22 - auto completion of XML and HTML tags
  23 - call tips
  24 - folding
  25 - many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal
  26 - symbol lists
  27 - embedded terminal emulation
  28 - extensibility through plugins
  29
  30
  31 Requirements
  32 ------------
  33 For compiling Geany yourself, you will need the GTK2 (>= 2.24) or
  34 GTK3 libraries and header files. You will also need its dependency libraries
  35 and header files, such as Pango, Glib and ATK. All these files are
  36 available at http://www.gtk.org.
  37
  38 Furthermore you need, of course, a C compiler and the Make tool; a C++
  39 compiler is also needed for the required Scintilla library included. The
  40 GNU versions of these tools are recommended.
  41
  42
  43 Installation
  44 ------------
  45
  46 To build the user manual you need *rst2html* from Docutils. A pre-built
  47 version of the manual is available in distribution tarballs and will be used as
  48 fallback if *rst2html* is missing. When building from Git however, that
  49 pre-built version is not included and *rst2html* is required by default.
  50 You can explicitly disable building the user manual using the
  51 ``--disable-html-docs`` *configure* flag, but this will result in not
  52 installing a local version of the user manual, and Geany will then try
  53 and open the online version instead when requested.
  54
  55 Installing from a Git clone
  56 +++++++++++++++++++++++++++
  57
  58 Install Autotools (*automake*, *autoconf* and *libtool*), *intltool*,
  59 and the GLib development files **before** running any of the following
  60 commands, as well as *rst2html* from Docutils (see above for details).
  61 Then, run ``./autogen.sh`` and then follow the instructions for
  62 `installing from a release tarball`_.
  63
  64 Installing from a release tarball
  65 +++++++++++++++++++++++++++++++++
  66
  67 Run the the following three commands::
  68
  69     $ ./configure
  70     $ make
  71     (as root, or using sudo)
  72     % make install
  73
  74 For more configuration details run ``./configure --help``
  75
  76 If there are any errors during compilation, check your build environment
  77 and try to find the error, otherwise contact the mailing list or one of
  78 the authors.
  79
  80 See the manual for details (geany.txt/geany.html).
  81
  82
  83 Usage
  84 -----
  85 To run Geany just type::
  86
  87     $ geany
  88
  89 on a console or use the applications menu from your desktop environment.
  90 There a few command line options. See the manual page of Geany or run::
  91
  92     $ geany --help
  93
  94 for details. Or look into the documentation in the *doc/* directory.
  95 The most important option probably is ``-c`` or ``--config``, where you can
  96 specify an alternate configuration directory.
  97
  98
  99 Windows
 100 -------
 101 Geany runs also under Windows. To download the binary with all necessary
 102 files, visit Geany's homepage. However, the Windows version has a few
 103 limitations:
 104
 105 - embedded terminal emulation (VTE) is missing
 106 - Windows Vista or newer is required
 107
 108
 109 License
 110 -------
 111 Geany is distributed under the terms of the GNU General Public License
 112 as published by the Free Software Foundation; either version 2 of the
 113 License, or (at your option) any later version.  A copy of this license
 114 can be found in the file COPYING included with the source code of this
 115 program.
 116 The included Scintilla library (found in the subdirectory scintilla/)
 117 has its own license, which can be found in the file scintilla/License.txt
 118 included with the source code of this program.
 119
 120
 121 Ideas, questions, patches and bug reports
 122 -----------------------------------------
 123 See http://www.geany.org/
 124 If you add something, or fix a bug, please send a patch (in Git or
 125 ``diff -u`` format) to the mailing list or one of the authors. Also see
 126 the HACKING file.
 127
 128
 129 --
 130 2005-2015 by Enrico Tröger, Nick Treleaven, Colomban Wendling, Matthew Brush and Frank Lanitz
 131 enrico(dot)troeger(at)uvena(dot)de
 132 nick(dot)treleaven(at)btinternet(dot)com
 133 lists(dot)ban(at)herbesfolles(dot)org
 134 mbrush(at)codebrainz(dot)ca
 135 frank(at)frank(dot)uvena(dot)de