[freetype2] gsoc-anurag-docs-2023 8657a9f98: [docs] Migrate Readme to markdown

[Werner Lemberg]

branch: gsoc-anurag-docs-2023
commit 8657a9f98501cfa015f14fd2ee5e305724f78a0b
Author: Anurag Thakur <anurag105csec21@bpitindia.edu.in>
Commit: Anurag Thakur <anurag105csec21@bpitindia.edu.in>

    [docs] Migrate Readme to markdown
---
 README    | 107 --------------------------------------------------------------
 README.md |  91 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 91 insertions(+), 107 deletions(-)

diff --git a/README b/README
deleted file mode 100644
index eb48e7e18..000000000
--- a/README
+++ /dev/null
@@ -1,107 +0,0 @@
-FreeType 2.13.1
-===============
-
-Homepage: https://www.freetype.org
-
-FreeType is a freely available software library to render fonts.
-
-It  is  written  in  C,   designed  to  be  small,  efficient,  highly
-customizable,  and portable  while capable  of producing  high-quality
-output (glyph images) of most vector and bitmap font formats.
-
-Please   read  the   `docs/CHANGES`   file,   it  contains   IMPORTANT
-INFORMATION.
-
-Read the files `docs/INSTALL*`  for installation instructions; see the
-file `docs/LICENSE.TXT` for the available licenses.
-
-For using FreeType's git repository  instead of a distribution bundle,
-please read file  `README.git`.  Note that you have  to actually clone
-the repository; using a snapshot will  not work (in other words, don't
-use gitlab's 'Download' button).
-
-The FreeType 2 API reference is located in directory `docs/reference`;
-use the file  `index.html` as the top entry point.   [Please note that
-currently  the search  function  for  locally installed  documentation
-doesn't work due to cross-site scripting issues.]
-
-Additional documentation is  available as a separate  package from our
-sites.  Go to
-
-  https://download.savannah.gnu.org/releases/freetype/
-
-and download one of the following files.
-
-  freetype-doc-2.13.1.tar.xz
-  freetype-doc-2.13.1.tar.gz
-  ftdoc2131.zip
-
-To view the documentation online, go to
-
-  https://www.freetype.org/freetype2/docs/
-
-
-Mailing Lists
--------------
-
-The preferred  way of  communication with the  FreeType team  is using
-e-mail lists.
-
-  general use and discussion:      freetype@nongnu.org
-  engine internals, porting, etc.: freetype-devel@nongnu.org
-  announcements:                   freetype-announce@nongnu.org
-  git repository tracker:          freetype-commit@nongnu.org
-
-The lists are moderated; see
-
-  https://www.freetype.org/contact.html
-
-how to subscribe.
-
-
-Bugs
-----
-
-Please submit bug reports at
-
-  https://gitlab.freedesktop.org/freetype/freetype/-/issues
-
-Alternatively,    you    might    report    bugs    by    e-mail    to
-`freetype-devel@nongnu.org`.    Don't  forget   to  send   a  detailed
-explanation of the problem -- there  is nothing worse than receiving a
-terse message that only says 'it doesn't work'.
-
-
-Patches
--------
-
-For larger changes please provide merge requests at
-
-  https://gitlab.freedesktop.org/freetype/freetype/-/merge_requests
-
-Alternatively, you can send patches to the `freetype-devel@nongnu.org`
-mailing list  -- and thank you  in advance for your  work on improving
-FreeType!
-
-Details on the process can be found here:
-
-  https://www.freetype.org/developer.html#patches
-
-
-Enjoy!
-
-  The FreeType Team
-
-----------------------------------------------------------------------
-
-Copyright (C) 2006-2023 by
-David Turner, Robert Wilhelm, and Werner Lemberg.
-
-This  file is  part of  the FreeType  project, and  may only  be used,
-modified,  and distributed  under the  terms of  the  FreeType project
-license,  LICENSE.TXT.  By  continuing to  use, modify,  or distribute
-this file you  indicate that you have read  the license and understand
-and accept it fully.
-
-
---- end of README ---
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..5afe73a7a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,91 @@
+# FreeType
+
+Homepage:
+>https://www.freetype.org
+
+FreeType is a freely available software library to render fonts.
+
+It is  written in C, designed to be small, efficient, highly
+customizable, and portable while capable of producing high-quality
+output (glyph images) of most vector and bitmap font formats.
+
+# Documentation
+The FreeType 2 API reference for the latest release, along with additional
+documentation can be found online at:
+
+>https://www.freetype.org/freetype2/docs/documentation.html
+
+Refer to [DOCGUIDE.md](docs/DOCGUIDE.md) for more information.
+
+# Compiling FreeType
+FreeType supports compilation via meson, GNU make and CMake
+
+Refer to [INSTALL.md](INSTALL.md) for more information.
+
+# Licensing
+FreeType is dual-licensed under the FTL and GPLv2.
+
+Refer to [COPYING.md](COPYING.md) for more information.
+
+# Reporting Issues
+Please submit bug reports at
+
+>https://gitlab.freedesktop.org/freetype/freetype/-/issues
+
+If you have suggestions for improving FreeType, they should be sent
+to the `freetype-devel` mailing list.
+
+
+# Improving FreeType
+For instructions on compiling FreeType, see [INSTALL.md](INSTALL.md).
+
+Please send merge requests to our gitlab repo at:
+
+>https://gitlab.freedesktop.org/freetype/freetype/
+
+Alternatively, you can send patches to the `freetype-devel` mailing list.
+Details on the process can be found here:
+
+>https://www.freetype.org/developer.html#patches
+
+Any non-trivial contribution should first be discussed with the maintainers
+via the `freetype-devel` mailing list.
+
+# Contact
+The preferred way of communication with the FreeType team is using
+mailing lists.
+
+| Email | Details |
+| ---  | ---     |
+|freetype@nongnu.org|    General use and discussion|
+|freetype-devel@nongnu.org|    Engine internals, Porting etc|
+|freetype-announce@nongnu.org|    Announcements|
+|freetype-commit@nongnu.org|    Git repository track|
+
+The lists are moderated; For more information, see
+>https://www.freetype.org/contact.html
+
+# Code of Conduct
+Please note that this project is released with a Contributor Code of
+Conduct (CoC). By participating in this project you agree to abide by
+its terms, which you can find in the following link:
+
+>https://www.freedesktop.org/wiki/CodeOfConduct
+
+CoC issues may be raised to the project maintainers at the following
+address:
+
+ - wl@gnu.org
+ - apodtele@gmail.com
+
+---
+```
+Copyright (C) 2006-2021 by
+David Turner, Robert Wilhelm, and Werner Lemberg.
+
+This  file is  part of  the FreeType  project, and  may only  be used,
+modified,  and distributed  under the  terms of  the  FreeType project
+license,  COPYING.md.  By  continuing to  use, modify,  or distribute
+this file you  indicate that you have read  the license and understand
+and accept it fully.
+```