[vala-extra-vapis] Change README to Markdown format and update Upstream Guide link
- From: Rico Tzschichholz <ricotz src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [vala-extra-vapis] Change README to Markdown format and update Upstream Guide link
- Date: Mon, 17 Sep 2018 17:13:41 +0000 (UTC)
commit 2031a85c5b71e00439c30d83efa5addb11f7602e
Author: Alistair Thomas <astavale yahoo co uk>
Date: Mon Apr 16 11:12:54 2018 +0100
Change README to Markdown format and update Upstream Guide link
README => README.md | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
---
diff --git a/README b/README.md
similarity index 80%
rename from README
rename to README.md
index ee8e869..d0b922e 100644
--- a/README
+++ b/README.md
@@ -2,15 +2,16 @@ This repository provides Vala bindings to various libraries which do
not provide their own bindings, and for which valac does not provide
bindings.
-== Rationale ==
+## Rationale
In most cases it is preferable for libraries to ship their own
bindings (some of the reasons why, as well as information on how to do
-so, are at http://live.gnome.org/Vala/UpstreamGuide). Some libraries,
-however, are unable or unwilling to do so. Other bindings are
-distributed with valac, but generally that is reserved for relatively
-popular libraries with well structured VAPIs and have a fairly strong
-aversion to breaking backwards compatibility.
+so, are at Vala Binding's
+[Upstream Guide](https://wiki.gnome.org/Projects/Vala/UpstreamGuide).
+Some libraries, however, are unable or unwilling to do so. Other
+bindings are distributed with valac, but generally that is reserved
+for relatively popular libraries with well structured VAPIs and have
+a fairly strong aversion to breaking backwards compatibility.
Bindings included in this repository are meant to be copied into your
project or used as a git submodule or subtree, and are *not* intended
@@ -28,7 +29,7 @@ bindings, preserving backwards compatibility, testing, etc. With that
in mind, this repository provides a good stable, central location for
bindings.
-== Usage ==
+## Usage
Because the bindings shipped in this repository provide no
backwards-compatibility promises, it is designed to be used as a git
@@ -36,7 +37,7 @@ submodule. If that is not acceptable (for example, if you don't use
git), it is recommended you simply copy the bindings you need into
your source tree.
-== Submitting Bindings For Inclusion ==
+## Submitting Bindings For Inclusion
If you have bindings which you would like to see housed in this
repository, simply submit a bug to the "Bindings: Extra" component in
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]