summaryrefslogtreecommitdiff
path: root/readlicense_oo
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /readlicense_oo
parent33da78c21f4243a3e469fb7df79ed1745df70078 (diff)
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>
Diffstat (limited to 'readlicense_oo')
-rw-r--r--readlicense_oo/README.md29
1 files changed, 15 insertions, 14 deletions
diff --git a/readlicense_oo/README.md b/readlicense_oo/README.md
index eb6c4482df15..2eae0bf5c3a6 100644
--- a/readlicense_oo/README.md
+++ b/readlicense_oo/README.md
@@ -1,33 +1,34 @@
+# LibreOffice Licensing Blurb
+
Contains the stock libreoffice licensing blurb, as distributed in the install
directory, and also potentially at run-time.
-Generating licence files
-------------------------
+## Generating Licence Files
-License files are generated from a single source file (license/license.xml).
+License files are generated from a single source file (`license/license.xml`).
Output file formats are plain text and html.
-- The plain text and the html format is generated with xslt. There are two
- separate xsl files for plain text and html.
+- The plain text and the html format is generated with XSLT. There are two
+ separate XSL files for plain text and html.
-Conditional text
-----------------
+## Conditional Text
The contents of the license file depends on the build configuration. Several
externals may or may not be shipped with LibreOffice. Therefore, we need to pass
-information about build configuration to the xslt processor.
+information about build configuration to the XSLT processor.
Variables used for conditional text:
-- BUILD_TYPE: A space separated list of libraries/externals. If an external is
+- `BUILD_TYPE`: A space separated list of libraries/externals. If an external is
present in that list, then the related license text should be included.
-- MPL_SUBSET: If the variable is defined, then GPL and LGPL license text will not
+- `MPL_SUBSET`: If the variable is defined, then GPL and LGPL license text will not
be included, because none of the built-in code need it.
-- OS: The target platform. E.g. MSVC Runtime is packaged and used only on Windows.
+- `OS`: The target platform. E.g. MSVC Runtime is packaged and used only on Windows.
+
+- `WITH_THEMES`: A space separated list of icon sets that are used in the build.
-- WITH_THEMES: A space separated list of icon sets that are used in the build.
+Conditional text are surrounded by and extra `<div>` tag. The class attribute of
+that `<div>` tag decides which parameter values are taken into consideration.
-Conditional text are surrounded by and extra <div> tag. The class attribute of
-that <div> tag decides which parameter values are taken into consideration.