README.md

   1 # LibreOffice
   2 [![Coverity Scan Build Status](https://scan.coverity.com/projects/211/badge.svg)](https://scan.coverity.com/projects/211) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/307/badge)](https://bestpractices.coreinfrastructure.org/projects/307) [![Translation status](https://weblate.documentfoundation.org/widgets/libo_ui-master/-/svg-badge.svg)](https://weblate.documentfoundation.org/engage/libo_ui-master/?utm_source=widget)
   3
   4 <img align="right" width="150" height="200" src="https://opensource.org/files/OSIApproved.png">
   5
   6 LibreOffice is an integrated office suite based on copyleft licenses
   7 and compatible with most document formats and standards. Libreoffice
   8 is backed by The Document Foundation, which represents a large
   9 independent community of enterprises, developers and other volunteers
  10 moved by the common goal of bringing to the market the best software
  11 for personal productivity. LibreOffice is open source, and free to
  12 download, use and distribute.
  13
  14 A quick overview of the LibreOffice code structure.
  15
  16 ## Overview
  17
  18 You can develop for LibreOffice in one of two ways, one
  19 recommended and one much less so. First the somewhat less recommended
  20 way: it is possible to use the SDK to develop an extension,
  21 for which you can read the [API docs](https://api.libreoffice.org/)
  22 and [Developers Guide](https://wiki.documentfoundation.org/Documentation/DevGuide).
  23 This re-uses the (extremely generic) UNO APIs that are also used by
  24 macro scripting in StarBasic.
  25
  26 The best way to add a generally useful feature to LibreOffice
  27 is to work on the code base however. Overall this way makes it easier
  28 to compile and build your code, it avoids any arbitrary limitations of
  29 our scripting APIs, and in general is far more simple and intuitive -
  30 if you are a reasonably able C++ programmer.
  31
  32 ## The Build Chain and Runtime Baselines
  33
  34 These are the current minimal operating system and compiler versions to
  35 run and compile LibreOffice, also used by the TDF builds:
  36
  37 * Windows:
  38     * Runtime: Windows 7
  39     * Build: Cygwin + Visual Studio 2019 version 16.10
  40 * macOS:
  41     * Runtime: 10.15
  42     * Build: 12 (13 for aarch64) + Xcode 14
  43 * Linux:
  44     * Runtime: RHEL 8 or CentOS 8 and comparable
  45     * Build: either GCC 12; or Clang 12 with libstdc++ 8.5
  46 * iOS (only for LibreOfficeKit):
  47     * Runtime: 11.4 (only support for newer i devices == 64 bit)
  48     * Build: Xcode 9.3 and iPhone SDK 11.4
  49 * Android:
  50     * Build: NDK r23 and SDK 30.0.3
  51 * Emscripten / WASM:
  52     * Runtime: a browser with SharedMemory support (threads + atomics)
  53     * Build: Qt 5.15 with Qt supported Emscripten 1.39.8
  54     * See [README.wasm](static/README.wasm.md)
  55
  56 Java is required for building many parts of LibreOffice. In TDF Wiki article
  57 [Development/Java](https://wiki.documentfoundation.org/Development/Java), the
  58 exact modules that depend on Java are listed.
  59
  60 The baseline for Java is Java Development Kit (JDK) Version 17 or later.
  61
  62 If you want to use Clang with the LibreOffice compiler plugins, the minimal
  63 version of Clang is 12.0.1. Since Xcode doesn't provide the compiler plugin
  64 headers, you have to compile your own Clang to use them on macOS.
  65
  66 You can find the TDF configure switches in the `distro-configs/` directory.
  67
  68 To setup your initial build environment on Windows and macOS, we provide
  69 the LibreOffice Development Environment
  70 ([LODE](https://wiki.documentfoundation.org/Development/lode)) scripts.
  71
  72 For more information see the build instructions for your platform in the
  73 [TDF wiki](https://wiki.documentfoundation.org/Development/How_to_build).
  74
  75 ## The Important Bits of Code
  76
  77 Each module should have a `README.md` file inside it which has some
  78 degree of documentation for that module; patches are most welcome to
  79 improve those. We have those turned into a web page here:
  80
  81 <https://docs.libreoffice.org/>
  82
  83 However, there are two hundred modules, many of them of only
  84 peripheral interest for a specialist audience. So - where is the
  85 good stuff, the code that is most useful. Here is a quick overview of
  86 the most important ones:
  87
  88 Module    | Description
  89 ----------|-------------------------------------------------
  90 [sal/](sal)             | this provides a simple System Abstraction Layer
  91 [tools/](tools)         | this provides basic internal types: `Rectangle`, `Color` etc.
  92 [vcl/](vcl)             | this is the widget toolkit library and one rendering abstraction
  93 [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
  94 [sfx2/](sfx2)           | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
  95 [svx/](svx)             | drawing model related helper code, including much of Draw/Impress
  96
  97 Then applications
  98
  99 Module    | Description
 100 ----------|-------------------------------------------------
 101 [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
 102 [sw/](sw/)           | Writer
 103 [sc/](sc/)           | Calc
 104 [sd/](sd/)           | Draw / Impress
 105
 106 There are several other libraries that are helpful from a graphical perspective:
 107
 108 Module    | Description
 109 ----------|-------------------------------------------------
 110 [basegfx/](basegfx)  | algorithms and data-types for graphics as used in the canvas
 111 [canvas/](canvas)   | new (UNO) canvas rendering model with various backends
 112 [cppcanvas/](cppcanvas) | C++ helper classes for using the UNO canvas
 113 [drawinglayer/](drawinglayer) | View code to render drawable objects and break them down into primitives we can render more easily.
 114
 115 ## Rules for #include Directives (C/C++)
 116
 117 Use the `"..."` form if and only if the included file is found next to the
 118 including file. Otherwise, use the `<...>` form. (For further details, see the
 119 mail [Re: C[++]: Normalizing include syntax ("" vs
 120 <>)](https://lists.freedesktop.org/archives/libreoffice/2017-November/078778.html).)
 121
 122 The UNO API include files should consistently use double quotes, for the
 123 benefit of external users of this API.
 124
 125 `loplugin:includeform (compilerplugins/clang/includeform.cxx)` enforces these rules.
 126
 127
 128 ## Finding Out More
 129
 130 Beyond this, you can read the `README.md` files, send us patches, ask
 131 on the mailing list libreoffice@lists.freedesktop.org (no subscription
 132 required) or poke people on IRC `#libreoffice-dev` on irc.libera.chat -
 133 we're a friendly and generally helpful mob. We know the code can be
 134 hard to get into at first, and so there are no silly questions.