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