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

Paolo Borelli's avatar
Paolo Borelli committed
4
This is version 3.15.1 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,
Paolo Maggi's avatar
Paolo Maggi committed
10 11
the GNOME Virtual File System and the GNOME print framework.

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

    * Complete support for UTF-8 text
Paolo Borelli's avatar
Paolo Borelli committed
24
    * Syntax highlighting
Paolo Borelli's avatar
Paolo Borelli committed
25
    * Support for editing remote files
26
    * Search and replace
Paolo Borelli's avatar
Paolo Borelli committed
27
    * Printing and Print Previewing Support
Paolo Borelli's avatar
Paolo Borelli committed
28
    * File Revert
Paolo Maggi's avatar
Paolo Maggi committed
29
    * A complete preferences interface
Paolo Borelli's avatar
Paolo Borelli committed
30
    * 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 35

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

    * Word count
Paolo Borelli's avatar
Paolo Borelli committed
36
    * Spell checker
Paolo Borelli's avatar
Paolo Borelli committed
37
    * File Browser
Paolo Borelli's avatar
Paolo Borelli committed
38
    * Automatic snippet expansion
Paolo Borelli's avatar
Paolo Borelli committed
39
    * Sort
Paolo Maggi's avatar
Paolo Maggi committed
40
    * Insert Date/Time
Paolo Borelli's avatar
Paolo Borelli committed
41 42
    * 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.


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


The official web site is:

53
    https://wiki.gnome.org/Apps/Gedit
Paolo Maggi's avatar
Paolo Maggi committed
54

55
You can download the latest gedit tarball from:
Paolo Maggi's avatar
Paolo Maggi committed
56

57
    https://download.gnome.org/sources/gedit/
Paolo Maggi's avatar
Paolo Maggi committed
58 59 60

Information about gedit mailing lists can be found at

61
    https://mail.gnome.org/mailman/listinfo/gedit-list
Paolo Maggi's avatar
Paolo Maggi committed
62 63 64 65 66


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

67 68 69 70 71
gedit requires GTK+ >= 3.14.0, GtkSourceView >= 3.14.0 and
libpeas >= 1.7.x libraries. It also has a run-time dependency on an
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.

Ignacio Casal Quinteiro's avatar
Ignacio Casal Quinteiro committed
72
PyGobject 3.0.x and gobject-introspection 0.9.0 are required to enable python
Ignacio Casal Quinteiro's avatar
Ignacio Casal Quinteiro committed
73
plugins support.
Paolo Maggi's avatar
Paolo Maggi committed
74 75 76

Simple install procedure:

Paolo Borelli's avatar
Paolo Borelli committed
77 78
  % tar Jxf gedit-3.15.1.tar.xz			# unpack the sources
  % cd gedit-3.15.1				# change to the toplevel directory
Paolo Borelli's avatar
Paolo Borelli committed
79 80
  % ./configure					# run the `configure' script
  % make					# build gedit
Paolo Maggi's avatar
Paolo Maggi committed
81
  [ Become root if necessary ]
Paolo Borelli's avatar
Paolo Borelli committed
82
  % make install				# install gedit
Paolo Maggi's avatar
Paolo Maggi committed
83 84 85 86 87 88 89 90

See the file 'INSTALL' for more detailed information.


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

Bugs should be reported to the GNOME bug tracking system.
Paolo Borelli's avatar
Paolo Borelli committed
91
(http://bugzilla.gnome.org, product gedit). You will need to create an
Paolo Maggi's avatar
Paolo Maggi committed
92 93 94
account for yourself.

In the bug report please include:
95

Paolo Maggi's avatar
Paolo Maggi committed
96 97
* Information about your system. For instance:

98
   - What version of gedit
Paolo Maggi's avatar
Paolo Maggi committed
99 100 101 102 103 104 105 106
   - What operating system and version
   - What version of the gtk+, glib and gnome libraries

  And anything else you think is relevant.

* How to reproduce the bug. 

* If the bug was a crash, the exact text that was printed out when the
107
  crash occurred.
Paolo Maggi's avatar
Paolo Maggi committed
108 109 110

* Further information such as stack traces may be useful, but is not
  necessary. If you do send a stack trace, and the error is an X error,
Paolo Maggi's avatar
Paolo Maggi committed
111
  it will be more useful if the stack trace is produced running the test
Paolo Maggi's avatar
Paolo Maggi committed
112 113 114 115 116 117 118 119 120 121 122 123 124
  program with the --sync command line option.


Patches
=======

Patches should also be submitted to bugzilla.gnome.org. If the patch
fixes an existing bug, add the patch as an attachment to that bug
report.

Otherwise, enter a new bug report that describes the patch, and attach
the patch to that bug report.

125
Please create patches with the git format-patch command.
Paolo Maggi's avatar
Paolo Maggi committed
126 127 128

If you are interested in helping us to develop gedit, please see the 
file 'AUTHOR' for contact information and/or send a message to the gedit
129
mailing list. See also the file 'HACKING' for more detailed information.
Paolo Maggi's avatar
Paolo Maggi committed
130 131


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