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 Installation from distribution packages
  32 ---------------------------------------
  33 Using distribution packages on Linux, BSD and similar distributions
  34 is the easiest and recommended way. This way you will also benefit
  35 from automatic Geany updates by the package manager of the distribution.
  36
  37 Packages are available for most distributions including Debian, Fedora, Ubuntu
  38 and many more.
  39
  40
  41 Installation on Mac OS and Windows
  42 ----------------------------------
  43 Prebuilt binary packages for Mac OS and Windows can be found on
  44 https://www.geany.org.
  45
  46
  47 Installation from sources
  48 -------------------------
  49
  50 Requirements
  51 ++++++++++++
  52 For compiling Geany yourself, you will need the GTK2 (>= 2.24) or
  53 GTK3 libraries and header files. You will also need its dependency libraries
  54 and header files, such as Pango, Glib and ATK. All these files are
  55 available at https://www.gtk.org.
  56
  57 Furthermore you need, of course, a C compiler and the Make tool; a C++
  58 compiler is also needed for the required Scintilla library included. The
  59 GNU versions of these tools are recommended.
  60
  61
  62 To build the user manual you need *rst2html* from Docutils. A pre-built
  63 version of the manual is available in distribution tarballs and will be used as
  64 fallback if *rst2html* is missing. When building from Git however, that
  65 pre-built version is not included and *rst2html* is required by default.
  66 You can explicitly disable building the user manual using the
  67 ``--disable-html-docs`` *configure* flag, but this will result in not
  68 installing a local version of the user manual, and Geany will then try
  69 and open the online version instead when requested.
  70
  71
  72 .. note::
  73     Building Geany from source on Mac OS and Windows is more complicated
  74     and is out of scope of this document. For more information on
  75     building instructions for these platforms, please check the wiki
  76     at https://wiki.geany.org/howtos/.
  77
  78 Installing from a Git clone
  79 +++++++++++++++++++++++++++
  80
  81 Install Autotools (*automake*, *autoconf* and *libtool*), *intltool*,
  82 and the GLib development files **before** running any of the following
  83 commands, as well as *rst2html* from Docutils (see above for details).
  84 Then, run ``./autogen.sh`` and then follow the instructions for
  85 `installing from a release tarball`_.
  86
  87 Installing from a release tarball
  88 +++++++++++++++++++++++++++++++++
  89
  90 Run the the following three commands::
  91
  92     $ ./configure
  93     $ make
  94     (as root, or using sudo)
  95     % make install
  96
  97 For more configuration details run ``./configure --help``.
  98
  99 If there are any errors during compilation, check your build environment
 100 and try to find the error, otherwise contact the mailing list or one of
 101 the authors.
 102
 103 See the manual for details (geany.txt/geany.html).
 104
 105
 106 Usage
 107 -----
 108 To run Geany just type::
 109
 110     $ geany
 111
 112 on a console or use the applications menu from your desktop environment.
 113 For command line options, see the manual page of Geany or run::
 114
 115     $ geany --help
 116
 117 for details. Or look into the documentation in the *doc/* directory.
 118 The most important option probably is ``-c`` or ``--config``, where you can
 119 specify an alternate configuration directory.
 120
 121
 122 License
 123 -------
 124 Geany is distributed under the terms of the GNU General Public License
 125 as published by the Free Software Foundation; either version 2 of the
 126 License, or (at your option) any later version.  A copy of this license
 127 can be found in the file COPYING included with the source code of this
 128 program.
 129 The included Scintilla library (found in the subdirectory scintilla/)
 130 has its own license, which can be found in the file scintilla/License.txt
 131 included with the source code of this program.
 132
 133
 134 Ideas, questions, patches and bug reports
 135 -----------------------------------------
 136 See https://www.geany.org/.
 137 If you add something, or fix a bug, please create a pull request at
 138 https://github.com/geany/geany/. Also see the HACKING file.