[gspell] docs: move most of the readme content to docs/more-information.md



commit 41ac00b6f28a43befbd1d207b09e788fc1de5a13
Author: Sébastien Wilmet <sw swilmet be>
Date:   Wed May 26 03:11:17 2021 +0200

    docs: move most of the readme content to docs/more-information.md
    
    The README.md file will be the entry point (instead of the web page).
    To have a more relocatable project, for the hosting (i.e. have a maximum
    of things in git).
    
    Also, further simplify the content, remove less useful things that are
    better documented elsewhere.

 README.md                | 61 +-----------------------------------------------
 docs/more-information.md | 56 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+), 60 deletions(-)
---
diff --git a/README.md b/README.md
index ce67503..0933c5a 100644
--- a/README.md
+++ b/README.md
@@ -1,65 +1,6 @@
 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.
+[More information about gspell](docs/more-information.md).
diff --git a/docs/more-information.md b/docs/more-information.md
new file mode 100644
index 0000000..06613d8
--- /dev/null
+++ b/docs/more-information.md
@@ -0,0 +1,56 @@
+gspell - more information
+=========================
+
+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,
+[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]