Updated README.md files to represent current code / use Markdown format

Previously, all of the README files have been renamed to README.md
and now, the contents of these files were changed to use Markdown
format. Other than format inconsistency, some README.md files lacked
information about modules, or were out of date. By using LibreOffice
/ OpenOffice wiki and other documentation websites, these files were
updated. Now every README.md file has a title, and some description.
The top-level README.md file is changed to add links to the modules.
The result of processing the Markdown format README.md files can be
seen at: https://docs.libreoffice.org/

Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>

1 files changed, 22 insertions, 22 deletions

diff --git a/README.md b/README.md
index 7da780aca76a..2e5561998892 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ to compile and build your code, it avoids any arbitrary limitations of
 our scripting APIs, and in general is far more simple and intuitive -
 if you are a reasonably able C++ programmer.
 
-## The build chain and runtime baselines
+## The Build Chain and Runtime Baselines
 
 These are the current minimal operating system and compiler versions to
 run and compile LibreOffice, also used by the TDF builds:
@@ -62,13 +62,13 @@ the LibreOffice Development Environment
 For more information see the build instructions for your platform in the
 [TDF wiki](https://wiki.documentfoundation.org/Development).
 
-## The important bits of code
+## The Important Bits of Code
 
-Each module should have a `README` file inside it which has some
+Each module should have a `README.md` file inside it which has some
 degree of documentation for that module; patches are most welcome to
 improve those. We have those turned into a web page here:
 
-https://docs.libreoffice.org/
+<https://docs.libreoffice.org/>
 
 However, there are two hundred modules, many of them of only
 peripheral interest for a specialist audience. So - where is the
@@ -77,32 +77,32 @@ the most important ones:
 
 Module    | Description
 ----------|-------------------------------------------------
-sal/      | this provides a simple System Abstraction Layer
-tools/    | this provides basic internal types: 'Rectangle', 'Color' etc.
-vcl/      | this is the widget toolkit library and one rendering abstraction
-framework | UNO framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from */uiconfig/* files
-sfx2/     | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
-svx/      | drawing model related helper code, including much of Draw/Impress
+[sal/](sal)             | this provides a simple System Abstraction Layer
+[tools/](tools)         | this provides basic internal types: `Rectangle`, `Color` etc.
+[vcl/](vcl)             | this is the widget toolkit library and one rendering abstraction
+[framework/](framework) | UNO framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from `/uiconfig/` files
+[sfx2/](sfx2)           | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
+[svx/](svx)             | drawing model related helper code, including much of Draw/Impress
 
 Then applications
 
 Module    | Description
 ----------|-------------------------------------------------
-desktop/  | this is where the 'main' for the application lives, init / bootstrap. the name dates back to an ancient StarOffice that also drew a desktop
-sw/       | Writer
-sc/       | Calc
-sd/       | Draw / Impress
+[desktop/](desktop)  | this is where the `main()` for the application lives, init / bootstrap. the name dates back to an ancient StarOffice that also drew a desktop
+[sw/](sw/)           | Writer
+[sc/](sc/)           | Calc
+[sd/](sd/)           | Draw / Impress
 
 There are several other libraries that are helpful from a graphical perspective:
 
 Module    | Description
 ----------|-------------------------------------------------
-basegfx/  | algorithms and data-types for graphics as used in the canvas
-canvas/   | new (UNO) canvas rendering model with various backends
-cppcanvas/ | C++ helper classes for using the UNO canvas
-drawinglayer/ | View code to render drawable objects and break them down into primitives we can render more easily.
+[basegfx/](basegfx)  | algorithms and data-types for graphics as used in the canvas
+[canvas/](canvas)   | new (UNO) canvas rendering model with various backends
+[cppcanvas/](cppcanvas) | C++ helper classes for using the UNO canvas
+[drawinglayer/](drawinglayer) | View code to render drawable objects and break them down into primitives we can render more easily.
 
-## Rules for #include directives (C/C++)
+## Rules for #include Directives (C/C++)
 
 Use the `"..."` form if and only if the included file is found next to the
 including file. Otherwise, use the `<...>` form. (For further details, see the
@@ -112,12 +112,12 @@ mail [Re: C[++]: Normalizing include syntax ("" vs
 The UNO API include files should consistently use double quotes, for the
 benefit of external users of this API.
 
-loplugin:includeform (compilerplugins/clang/includeform.cxx) enforces these rules.
+`loplugin:includeform (compilerplugins/clang/includeform.cxx)` enforces these rules.
 
 
-## Finding out more
+## Finding Out More
 
-Beyond this, you can read the `README` files, send us patches, ask
+Beyond this, you can read the `README.md` files, send us patches, ask
 on the mailing list libreoffice@lists.freedesktop.org (no subscription
 required) or poke people on IRC `#libreoffice-dev` on irc.freenode.net -
 we're a friendly and generally helpful mob. We know the code can be