Repository files navigation

Geany is a small and lightweight integrated development environment.It was developed to provide a small and fast IDE, which has only afew dependencies from other packages. Another goal was to be as independentas possible from a special Desktop Environment like KDE or GNOME. So itis using only the GTK+ toolkit and therefore you need only theGTK+ runtime libraries to run Geany.

The basic features of Geany are:

• syntax highlighting
• code completion
• auto completion of often used constructs like if, for and while
• auto completion of XML and HTML tags
• call tips
• folding
• many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal
• symbol lists
• embedded terminal emulation
• extensibility through plugins

Using distribution packages on Linux, BSD and similar distributionsis the easiest and recommended way. This way you will also benefitfrom automatic Geany updates by the package manager of the distribution.

Packages are available for most distributions including Debian, Fedora, Ubuntuand many more.

Prebuilt binary packages for Mac OS and Windows can be found onhttps://www.geany.org.

For compiling Geany yourself, you will need the GTK3 libraries andheader files. You will also need its dependency libraries and headerfiles, such as Pango, Glib and ATK. All these files are available athttps://www.gtk.org.

Furthermore you need, of course, a C compiler and the Make tool; a C++compiler is also needed for the required Scintilla library included. TheGNU versions of these tools are recommended.

To build the user manual you needrst2html from Docutils. A pre-builtversion of the manual is available in distribution tarballs and will be used asfallback ifrst2html is missing. When building from Git however, thatpre-built version is not included andrst2html is required by default.You can explicitly disable building the user manual using the--disable-html-docsconfigure flag, but this will result in notinstalling a local version of the user manual, and Geany will then tryand open the online version instead when requested.

N.B. Meson support is still incomplete and a work-in-progress.

Meson requires to chose a separate build directory. Either createone, or let meson do it:

meson build ormkdir build; cd build; meson ..

Either command will configure the build system. The system is probedin many ways and system-dependant build files are created. This includeslocation of dependencies and compiler and linker flags required for them.

To build Geany, follow with ameson compile -C build

To install Geany, follow the build with asudo meson install -C build.

By default, meson will install Geany to/usr/local. A differentprefix can be selected at the initial command or via reconfiguration:

meson --prefix /opt build ormeson configure --prefix /opt build

Geany has some selectable features that may reduce the requiredbuild and runtime dependencies. See meson_optionts.txt for a full list.

To turn a feature off, use-D<feature>=false when configuring the build,for example:meson configure -Dvte=false build

Install Autotools (autopoint,automake,autoconf andlibtool),gettext, and the GLib development filesbefore running any of thefollowing commands, as well asrst2html from Docutils (see above fordetails). Then, run./autogen.sh and then follow the instructions forinstalling from a release tarball.

Run the the following three commands:

$ ./configure$ make(as root, or using sudo)% make install

For more configuration details run./configure --help.

If there are any errors during compilation, check your build environmentand try to find the error, otherwise contact the mailing list or one ofthe authors.

See the manual for details (geany.txt/geany.html).

To run Geany just type:

$ geany

on a console or use the applications menu from your desktop environment.For command line options, see the manual page of Geany or run:

$ geany --help

for details. Or look into the documentation in thedoc/ directory.The most important option probably is-c or--config, where you canspecify an alternate configuration directory.

Geany is distributed under the terms of the GNU General Public Licenseas published by the Free Software Foundation; either version 2 of theLicense, or (at your option) any later version. A copy of this licensecan be found in the file COPYING included with the source code of thisprogram.The included Scintilla library (found in the subdirectory scintilla/)has its own license, which can be found in the file scintilla/License.txtincluded with the source code of this program.

Seehttps://www.geany.org/.If you add something, or fix a bug, please create a pull request athttps://github.com/geany/geany/. Also see the HACKING file.