summaryrefslogtreecommitdiff
path: root/desktop
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 /desktop
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 'desktop')
-rw-r--r--desktop/README.md29
1 files changed, 17 insertions, 12 deletions
diff --git a/desktop/README.md b/desktop/README.md
index a49f0051ae1f..1474f11e2718 100644
--- a/desktop/README.md
+++ b/desktop/README.md
@@ -1,28 +1,28 @@
-What used to be the desktop in StarOffice 5 - now the binary.
+# LibreOffice Binary
+Code for the LibreOffice main binary (`soffice`) resides here. The `soffice_main`
+function for the `soffice` binary can be found here.
-Stable Interface
-================
+
+## Stable Interface
Some of the artifacts built here are part of a LibreOffice installation set's
stable interface, which (programmatic) clients can depend on. Among them are:
-soffice
-=======
+### soffice
-In the "program" directory ("program/" on Linux and Windows, "Contents/MacOS/"
+In the `program` directory (`program/` on Linux and Windows, `Contents/MacOS/`
on macOS).
-unoinfo
-=======
+### unoinfo
-In the "program" directory ("program/" on Linux and Windows, "Contents/MacOS/"
+In the `program` directory (`program/` on Linux and Windows, `Contents/MacOS/`
on macOS).
-When called with a sole argument of "c++", it prints to stdout an absolute
+When called with a sole argument of `c++`, it prints to stdout an absolute
pathname denoting the directory where the public URE libraries are found.
-When called with a sole argument of "java", it prints to stdout a marker
+When called with a sole argument of `java`, it prints to stdout a marker
character (either an ASCII '0' or '1') followed by a sequence of zero or more
absolute pathnames denoting jars or directories that need to be included in a
class loader's search locations.
@@ -33,4 +33,9 @@ other by NUL bytes.
If the marker character is '1' (on Windows), the pathnames are encoded as
UTF-16-LE two-byte code units, and any two pathnames in the sequence are
-separated from each other by two-byte NUL code units.
+separated from each other by two-byte `NUL` code units.
+
+## Other Binaries
+
+### oosplash
+Splash screen for the LibreOffice `soffice` binary.