README.md 3 KB
Newer Older
Paolo Maggi's avatar
Paolo Maggi committed
1 2
General Information
===================
Jose Maria Celorio's avatar
Jose Maria Celorio committed
3

Jeremy Bicha's avatar
Jeremy Bicha committed
4
This is version 3.32.0 of gedit. gedit is a small and lightweight UTF-8 text
Paolo Maggi's avatar
Paolo Maggi committed
5
editor for the GNOME environment.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
6

Paolo Borelli's avatar
Paolo Borelli committed
7
gedit is part of GNOME and uses the latest GTK+ and GNOME libraries.
Paolo Maggi's avatar
Paolo Maggi committed
8
Complete GNOME integration is featured, with support for Drag and Drop (DnD) 
Paolo Borelli's avatar
Paolo Borelli committed
9
from Nautilus (the GNOME file manager), the use of the GNOME help system,
10
the Virtual File System GVfs and the GTK+ print framework.
Paolo Maggi's avatar
Paolo Maggi committed
11

Paolo Maggi's avatar
Paolo Maggi committed
12 13
gedit uses a Multiple Document Interface (MDI), which lets you edit more than 
one document at the same time.
Paolo Maggi's avatar
Paolo Maggi committed
14 15 16 17

gedit supports most standard editing features, plus several not found in your 
average text editor (plugins being the most notable of these).

18 19
The gedit core is written in the C language. Thanks to GObject introspection,
plugins may also be written in other languages, like Vala and Python.
Paolo Borelli's avatar
Paolo Borelli committed
20

Paolo Borelli's avatar
Paolo Borelli committed
21
Although new features are always under development, currently gedit has:
Paolo Maggi's avatar
Paolo Maggi committed
22

23 24 25 26 27 28 29 30
* Complete support for UTF-8 text
* Syntax highlighting
* Support for editing remote files
* Search and replace
* Printing and Print Previewing Support
* File Revert
* A complete preferences interface
* Configurable Plugin system, with optional python support
Paolo Borelli's avatar
Paolo Borelli committed
31

Paolo Maggi's avatar
Paolo Maggi committed
32 33 34

Some of the plugins, packaged and installed with gedit include, among others:

35 36 37 38 39 40 41 42
* Word count
* Spell checker
* File Browser
* Automatic snippet expansion
* Sort
* Insert Date/Time
* External Tools
* Tag list
Paolo Maggi's avatar
Paolo Maggi committed
43

Paolo Borelli's avatar
Paolo Borelli committed
44 45 46
Other external plugins are also available.


47 48
gedit is released under the GNU General Public License (GPL) version 2 or
later, see the file 'COPYING' for more information.
Paolo Maggi's avatar
Paolo Maggi committed
49 50


51 52
Resources
=========
Paolo Maggi's avatar
Paolo Maggi committed
53

54 55 56
* [Official web site](https://wiki.gnome.org/Apps/Gedit)
* [Latest gedit tarball](https://download.gnome.org/sources/gedit/)
* [Information about gedit mailing lists](https://mail.gnome.org/mailman/listinfo/gedit-list)
Paolo Maggi's avatar
Paolo Maggi committed
57 58 59 60 61


Installation
============

62
gedit requires `GTK+ >= 3.22.0`, `GtkSourceView >= 4.0.2` and
63
`libpeas >= 1.14.1` libraries. It also has a run-time dependency on an
64 65 66
icon theme for its icons. If gedit fails to display icons, installing
GNOME's default adwaita-icon-theme is a simple way of providing them.

67
`PyGObject 3.0.x` and `gobject-introspection 1.42.0` are required to enable
Paolo Borelli's avatar
Paolo Borelli committed
68 69
python plugins support.

70
`gspell >= 0.2.5` is required to enable the spell checking plugin.
Paolo Maggi's avatar
Paolo Maggi committed
71 72 73

Simple install procedure:

74
```
Jeremy Bicha's avatar
Jeremy Bicha committed
75 76
% tar Jxf gedit-3.32.0.tar.xz			# unpack the sources
% cd gedit-3.32.0				# change to the toplevel directory
77 78
% meson _build					# run the `configure' script
% ninja -C _build				# build gedit
79
[ Become root if necessary ]
80
% ninja -C _build install				# install gedit
81
```
Paolo Maggi's avatar
Paolo Maggi committed
82 83 84 85

How to report bugs
==================

86
Bugs should be reported to the [GNOME bug tracking system](https://wiki.gnome.org/Apps/Gedit/ReportingBugs).
Paolo Maggi's avatar
Paolo Maggi committed
87 88


89 90
Contributions
=============
Paolo Maggi's avatar
Paolo Maggi committed
91

92 93
To contribute changes to the project, please fork the project on [the GNOME gitlab instance](https://gitlab.gnome.org/GNOME/gedit) and open a merge request.
If the change fixes an existing bug, add the issue number in the merge request comment.
Paolo Maggi's avatar
Paolo Maggi committed
94

95
See the file 'HACKING' for more detailed information.
Paolo Maggi's avatar
Paolo Maggi committed
96 97


Paolo Borelli's avatar
Paolo Borelli committed
98
  The gedit team.