summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1b9cdd6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+gedit
+=====
+
+gedit is a general-purpose text editor. It has been created in 1998, at the
+beginnings of GNOME.
+
+The first goal of gedit is to be easy to use, with a simple interface by
+default. More advanced features are available by enabling plugins.
+
+See the [gedit official website](https://wiki.gnome.org/Apps/Gedit) for
+more information.
+
+License
+-------
+
+gedit is released under the GNU General Public License (GPL) version 2 or
+later, see the file [COPYING](COPYING) for more information.
+
+Dependencies
+------------
+
+gedit depends on GTK 3.
+
+For a complete list of dependencies, see the file [meson.build](meson.build).
+
+Installation
+------------
+
+To build gedit from source, see the [docs/build.md](docs/build.md) file.
+
+How to report bugs
+------------------
+
+Please read
+[the wiki page on how to report bugs](https://wiki.gnome.org/Apps/Gedit/ReportingBugs),
+it contains a list of frequently reported bugs and a link to the bug
+tracker.
+
+Development resources
+---------------------
+
+- [gedit on GitLab](https://gitlab.gnome.org/GNOME/gedit)
+- [gedit-plugins on GitLab](https://gitlab.gnome.org/GNOME/gedit-plugins)
+- [Tarballs](https://download.gnome.org/sources/gedit/)
+- [Roadmap](docs/roadmap.md)
+- [gedit wiki attic](https://wiki.gnome.org/Apps/Gedit/Attic)
+
+Contributions
+-------------
+
+gedit development relies on voluntary contributions and everyone is invited
+to help.
+
+See the file [CONTRIBUTING.md](CONTRIBUTING.md) for more information.