[gedit/wip/misc] docs: Markdown: links to other files in the same repo
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gedit/wip/misc] docs: Markdown: links to other files in the same repo
- Date: Wed, 28 Aug 2019 06:09:13 +0000 (UTC)
commit c6d3621c3cfc7a4b6f091e79b3daba84d8842a4d
Author: Sébastien Wilmet <swilmet gnome org>
Date: Wed Aug 28 07:16:12 2019 +0200
docs: Markdown: links to other files in the same repo
It's supported by both GitLab and GitHub.
CONTRIBUTING.md | 2 +-
README.md | 10 +++++-----
docs/gedit-development-getting-started.md | 15 ++++++++-------
3 files changed, 14 insertions(+), 13 deletions(-)
---
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4c2a2a9ad..adc92ddd5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,7 +24,7 @@ Software development
--------------------
To get started with gedit software development, see the file
-`docs/gedit-development-getting-started.md`.
+[docs/gedit-development-getting-started.md](docs/gedit-development-getting-started.md).
gedit follows the same guidelines and code conventions as GtkSourceView. See
the [GtkSourceView HACKING file](https://gitlab.gnome.org/GNOME/gtksourceview/blob/master/HACKING).
diff --git a/README.md b/README.md
index 209d09400..c548a6672 100644
--- a/README.md
+++ b/README.md
@@ -21,20 +21,20 @@ License
-------
gedit is released under the GNU General Public License (GPL) version 2 or
-later, see the file `COPYING` for more information.
+later, see the file [COPYING](COPYING) for more information.
Dependencies
------------
gedit uses the GTK GUI toolkit.
-For a complete list of dependencies, see the file `meson.build` and search
-the section “Dependencies”.
+For a complete list of dependencies, see the file [meson.build](meson.build) and
+search the section “Dependencies”.
Installation
------------
-See the `docs/install.md` file.
+See the [docs/install.md](docs/install.md) file.
How to report bugs
------------------
@@ -50,4 +50,4 @@ Contributions
gedit development relies on voluntary contributions and everyone is invited
to help.
-See the file `CONTRIBUTING.md` for more information.
+See the file [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
diff --git a/docs/gedit-development-getting-started.md b/docs/gedit-development-getting-started.md
index 69dc5689a..c1a74c653 100644
--- a/docs/gedit-development-getting-started.md
+++ b/docs/gedit-development-getting-started.md
@@ -54,13 +54,14 @@ gedit core provides:
- A basic text editor.
- The integration of libpeas, with an API for plugins.
-There is a class diagram of gedit core in the file `class-diagram.dia` (but it
-may be outdated, see the Git log for that file).
+There is a class diagram of gedit core in the file
+[class-diagram.dia](class-diagram.dia) (but it may be outdated, see the Git log
+for that file).
Build/Installation
------------------
-See the file `install.md`.
+See the file [install.md](install.md).
First contribution
------------------
@@ -68,10 +69,10 @@ First contribution
See the [Newcomers](https://wiki.gnome.org/Newcomers/) page to start
contributing to GNOME in general.
-To know how to contribute to gedit specifically, read the `README.md` and
-`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).
+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).
To find something interesting to do, […]. TODO: provide list of easy tasks in
gedit itself.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]