[tepl] readme: Markdown format, update and improve
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tepl] readme: Markdown format, update and improve
- Date: Fri, 6 Nov 2020 07:44:00 +0000 (UTC)
commit d027a6aca3ae581d5ef36fdb4dec6711ab01650e
Author: Sébastien Wilmet <swilmet gnome org>
Date: Fri Nov 6 08:42:42 2020 +0100
readme: Markdown format, update and improve
README | 54 ------------------------------------------------------
README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
2 files changed, 43 insertions(+), 54 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9e14d3a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+Tepl - Text editor product line
+===============================
+
+This is version 5.1.2 of Tepl.
+
+Tepl is a library that eases the development of GtkSourceView-based text
+editors and IDEs.
+
+Tepl was previously named Gtef (GTK text editor framework). The project has
+been renamed in June 2017 to have a more beautiful name. The end of Tepl is
+pronounced like in “apple”.
+
+The Tepl library is free software and is released under the terms of the GNU
+Lesser General Public License, see the `LICENSES/` directory for more
+information.
+
+See also the [Tepl web page](https://wiki.gnome.org/Projects/Tepl).
+
+Dependencies
+------------
+
+- GLib >= 2.64
+- GTK >= 3.22
+- GtkSourceView >= 4.0
+- [Amtk](https://wiki.gnome.org/Projects/Amtk) >= 5.0
+- [ICU](http://site.icu-project.org/)
+
+Installation
+------------
+
+To build the latest version of Tepl plus its dependencies from Git,
+[Jhbuild](https://wiki.gnome.org/Projects/Jhbuild) is recommended.
+
+Documentation
+-------------
+
+See the `gtk_doc` Meson option. A convenient way to read the API documentation
+is with the [Devhelp](https://wiki.gnome.org/Apps/Devhelp) application.
+
+How to contribute
+-----------------
+
+See the file `HACKING`.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]