[gedit] docs: gedit-development-getting-started.md: an update
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gedit] docs: gedit-development-getting-started.md: an update
- Date: Fri, 15 Jul 2022 12:46:25 +0000 (UTC)
commit 994cfff67a579fd75348c83dcb7c335548ce15fd
Author: Sébastien Wilmet <swilmet informatique-libre be>
Date: Fri Jul 15 14:44:42 2022 +0200
docs: gedit-development-getting-started.md: an update
Simplify or improve some parts. Update some links, etc.
docs/gedit-development-getting-started.md | 37 +++++++++++++------------------
1 file changed, 16 insertions(+), 21 deletions(-)
---
diff --git a/docs/gedit-development-getting-started.md b/docs/gedit-development-getting-started.md
index 4f930afc7..8cc4c565e 100644
--- a/docs/gedit-development-getting-started.md
+++ b/docs/gedit-development-getting-started.md
@@ -8,14 +8,14 @@ Programming languages and paradigms
-----------------------------------
gedit is mostly written in C, with some plugins in Python or
-[Vala](https://wiki.gnome.org/Projects/Vala/). The build system is in
-[Meson](https://mesonbuild.com/).
+[Vala](https://wiki.gnome.org/Projects/Vala/). The
+[Meson](https://mesonbuild.com/) build system is used.
The code is object-oriented and event-driven. In C, it's thanks to the use of
the GObject library (see next section). If you open some `*.c` or `*.h` files,
-you may think “what is this horror?!” but – don't panic – it's just some
-C/GObject boilerplate code, and that boilerplate can be generated by a tool. So
-once you've learned GObject, you will no longer be afraid ;-)
+you may be frightened but – don't panic – it's just some C/GObject boilerplate
+code, and that boilerplate can be generated by a tool. So once you've learned
+GObject, you will no longer be afraid ;-)
Libraries used
--------------
@@ -23,7 +23,7 @@ Libraries used
As every GNOME application, gedit uses the GLib, GObject and GTK libraries. To
modify the gedit source code, you should be familiar with those libraries. See
the [GTK website](https://www.gtk.org/) and the document
-[The GLib/GTK Development Platform – A Getting Started
Guide](https://people.gnome.org/~swilmet/glib-gtk-book/).
+[The GLib/GTK Development Platform – A Getting Started
Guide](https://informatique-libre.be/swilmet/glib-gtk-book/).
The main widget used by gedit is GtkTextView, a general-purpose multiline text
editor. To learn that widget API, read the excellent
@@ -34,14 +34,14 @@ actually uses the
contains a subclass of GtkTextView with many features useful for a text editor
or an IDE. But GtkSourceView is not enough to have a full-blown text editor,
gedit is actually in the process of using more features from the
-[Tepl](https://wiki.gnome.org/Projects/Tepl) library, and to further develop
+[Tepl](https://gitlab.gnome.org/swilmet/tepl) library, and to further develop
Tepl alongside gedit.
For its plugin system, gedit uses the
[libpeas](https://wiki.gnome.org/Projects/Libpeas) library.
Plugins may have other dependencies, for example the spell-checking plugin uses
-[gspell](https://wiki.gnome.org/Projects/gspell).
+[gspell](https://gitlab.gnome.org/GNOME/gspell).
gedit architecture
------------------
@@ -50,7 +50,7 @@ The [gedit Git repository](https://gitlab.gnome.org/GNOME/gedit) contains the
_gedit core_ plus the default plugins. There is also the
[gedit-plugins Git repository](https://gitlab.gnome.org/GNOME/gedit-plugins)
for additional official plugins. The gedit core source code is in the `gedit/`
-directory. The plugins are in … `plugins/`!
+directory. And as can be expected, the plugins are in …*drum roll*: `plugins/`!
gedit core provides:
- A basic text editor.
@@ -65,8 +65,8 @@ Build/Installation
See the file [build.md](build.md).
-First contribution
-------------------
+More information
+----------------
See the [Newcomers](https://wiki.gnome.org/Newcomers/) page to start
contributing to GNOME in general. But perhaps some things explained there are
@@ -74,9 +74,7 @@ not relevant for gedit, in case of doubt the gedit documentation takes
precedence.
To know how to contribute to gedit specifically, read the
-[README.md](../README.md) and [CONTRIBUTING.md](../CONTRIBUTING.md) files
-present in the Git repository (and then you'll see that the `CONTRIBUTING.md`
-file refers to this file, but please don't end up in an infinite reading loop).
+[CONTRIBUTING.md](../CONTRIBUTING.md) file.
A good way to learn a lot of things is to write a new plugin (as a third-party
plugin first).
@@ -89,12 +87,9 @@ Improvements to the documentation (for users or developers) is also useful,
especially to improve the API reference for developing gedit plugins.
Note that gedit, although simple to use, is old. Some parts of the code is
-legacy code. The remaining tasks to do are often not simple, the codebase needs
-a lot of refactoring, and to do it properly an experienced developer is advised.
-That's why writing plugins is normally easier.
+legacy code and would benefit from some refactoring. That's why writing plugins
+is normally easier.
-Interesting article to read, written by a GNOME developer:
-[Working on Free Software](http://ometer.com/hacking.html)
+ Happy hacking,
-Happy hacking!\
-the gedit developers.
+ the gedit developers.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]