[gspell] docs: provide a README.md file in addition to the README



commit f821e890646ab436595a8f562f387493a4ec3225
Author: Sébastien Wilmet <sw swilmet be>
Date:   Wed May 26 02:49:12 2021 +0200

    docs: provide a README.md file in addition to the README
    
    The 'README' file is still needed, because of the Autotools build
    system.
    
    Markdown-ify the readme in README.md, and update and simplify a little
    the content.

 README    | 70 +--------------------------------------------------------------
 README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+), 69 deletions(-)
---
diff --git a/README b/README
index 595fc83..69b3a83 100644
--- a/README
+++ b/README
@@ -1,69 +1 @@
-gspell - a spell-checking library for GTK applications
-======================================================
-
-This is version 1.9.1 of gspell.
-
-gspell provides a flexible API to add spell-checking to a GTK application.
-
-The gspell library is free software and is released under the terms of the GNU
-LGPL version 2.1 or later. See the file 'COPYING' for more information.
-
-The official web site is:
-
-    https://wiki.gnome.org/Projects/gspell
-
-About versions
---------------
-
-gspell follows the GNOME release schedule and uses the same versioning scheme:
-
-    https://developer.gnome.org/programming-guidelines/stable/versioning.html.en
-
-For example the 1.7.x versions are unstable, and the 1.8.x versions are stable.
-
-Dependencies
-------------
-
-* GLib >= 2.44
-* GTK >= 3.20
-* Enchant >= 2.2.12
-* ICU - http://site.icu-project.org/
-
-Notes for packagers
--------------------
-
-At least on GNU/Linux, it is better to install hunspell. aspell can be
-considered deprecated and doesn't work well with gspell. If both hunspell and
-aspell are installed, Enchant prefers hunspell by default.
-
-See also:
-
-    https://fedoraproject.org/wiki/Releases/FeatureDictionary
-    https://wiki.ubuntu.com/ConsolidateSpellingLibs
-
-Installation
-------------
-
-Simple install procedure from a tarball:
-
-  $ ./configure
-  $ make
-  [ Become root if necessary ]
-  $ make install
-
-See the file 'INSTALL' for more detailed information.
-
-From the Git repository, the 'configure' script and the 'INSTALL' file are not
-yet generated, so you need to run 'autogen.sh' instead, which takes the same
-arguments as 'configure'.
-
-To build the latest version of gspell plus its dependencies from Git, Jhbuild
-is recommended:
-
-    https://wiki.gnome.org/Projects/Jhbuild
-
-Contributions
--------------
-
-Contributions are no longer accepted for this project. See the `HACKING` file
-for more information.
+See the README.md file.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ce67503
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+gspell - a spell-checking library for GTK applications
+======================================================
+
+This is version 1.9.1 of gspell.
+
+gspell provides a flexible API to add spell-checking to a GTK application.
+
+The gspell library is free software and is released under the terms of the GNU
+LGPL version 2.1 or later. See the file 'COPYING' for more information.
+
+The [official web page of gspell](https://wiki.gnome.org/Projects/gspell).
+
+About versions
+--------------
+
+gspell follows the GNOME release schedule and uses the same
+[versioning scheme](https://developer.gnome.org/programming-guidelines/stable/versioning.html.en).
+
+For example the 1.7.x versions are unstable, and the 1.8.x versions are stable.
+
+Dependencies
+------------
+
+* GLib
+* GTK
+* Enchant
+* [ICU](http://site.icu-project.org/)
+
+Notes for packagers
+-------------------
+
+At least on GNU/Linux, it is better to install hunspell. aspell can be
+considered deprecated and doesn't work well with gspell. If both hunspell and
+aspell are installed, Enchant prefers hunspell by default.
+
+See also:
+- https://fedoraproject.org/wiki/Releases/FeatureDictionary
+- https://wiki.ubuntu.com/ConsolidateSpellingLibs
+
+Installation
+------------
+
+Simple install procedure from a tarball:
+
+```
+$ ./configure
+$ make
+[ Become root if necessary ]
+$ make install
+```
+
+See the file 'INSTALL' for more detailed information.
+
+From the Git repository, the 'configure' script and the 'INSTALL' file are not
+yet generated, so you need to run 'autogen.sh' instead, which takes the same
+arguments as 'configure'.
+
+To build the latest version of gspell plus some of its dependencies from Git,
+[Jhbuild](https://wiki.gnome.org/Projects/Jhbuild) can be used.
+
+Contributions
+-------------
+
+Contributions are no longer accepted for this project. See the `HACKING` file
+for more information.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]