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 [here](https://api.libreoffice.org/)
  22 and [here](https://wiki.openoffice.org/wiki/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.5
  40 * macOS:
  41     * Runtime: 10.12
  42     * Build: 10.14.4 + Xcode 11.3
  43 * Linux:
  44     * Runtime: RHEL 7 or CentOS 7
  45     * Build: either GCC 7.0.0; or Clang 5.0.2 with libstdc++ 7.3.0
  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 r19c and SDK 22.6.2
  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
  55
  56 If you want to use Clang with the LibreOffice compiler plugins, the minimal
  57 version of Clang is 5.0.2. Since Xcode doesn't provide the compiler plugin
  58 headers, you have to compile your own Clang to use them on macOS.
  59
  60 You can find the TDF configure switches in the `distro-configs/` directory.
  61
  62 To setup your initial build environment on Windows and macOS, we provide
  63 the LibreOffice Development Environment
  64 ([LODE](https://wiki.documentfoundation.org/Development/lode)) scripts.
  65
  66 For more information see the build instructions for your platform in the
  67 [TDF wiki](https://wiki.documentfoundation.org/Development).
  68
  69 ## The Important Bits of Code
  70
  71 Each module should have a `README.md` file inside it which has some
  72 degree of documentation for that module; patches are most welcome to
  73 improve those. We have those turned into a web page here:
  74
  75 <https://docs.libreoffice.org/>
  76
  77 However, there are two hundred modules, many of them of only
  78 peripheral interest for a specialist audience. So - where is the
  79 good stuff, the code that is most useful. Here is a quick overview of
  80 the most important ones:
  81
  82 Module    | Description
  83 ----------|-------------------------------------------------
  84 [sal/](sal)             | this provides a simple System Abstraction Layer
  85 [tools/](tools)         | this provides basic internal types: `Rectangle`, `Color` etc.
  86 [vcl/](vcl)             | this is the widget toolkit library and one rendering abstraction
  87 [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
  88 [sfx2/](sfx2)           | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
  89 [svx/](svx)             | drawing model related helper code, including much of Draw/Impress
  90
  91 Then applications
  92
  93 Module    | Description
  94 ----------|-------------------------------------------------
  95 [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
  96 [sw/](sw/)           | Writer
  97 [sc/](sc/)           | Calc
  98 [sd/](sd/)           | Draw / Impress
  99
 100 There are several other libraries that are helpful from a graphical perspective:
 101
 102 Module    | Description
 103 ----------|-------------------------------------------------
 104 [basegfx/](basegfx)  | algorithms and data-types for graphics as used in the canvas
 105 [canvas/](canvas)   | new (UNO) canvas rendering model with various backends
 106 [cppcanvas/](cppcanvas) | C++ helper classes for using the UNO canvas
 107 [drawinglayer/](drawinglayer) | View code to render drawable objects and break them down into primitives we can render more easily.
 108
 109 ## Rules for #include Directives (C/C++)
 110
 111 Use the `"..."` form if and only if the included file is found next to the
 112 including file. Otherwise, use the `<...>` form. (For further details, see the
 113 mail [Re: C[++]: Normalizing include syntax ("" vs
 114 <>)](https://lists.freedesktop.org/archives/libreoffice/2017-November/078778.html).)
 115
 116 The UNO API include files should consistently use double quotes, for the
 117 benefit of external users of this API.
 118
 119 `loplugin:includeform (compilerplugins/clang/includeform.cxx)` enforces these rules.
 120
 121
 122 ## Finding Out More
 123
 124 Beyond this, you can read the `README.md` files, send us patches, ask
 125 on the mailing list libreoffice@lists.freedesktop.org (no subscription
 126 required) or poke people on IRC `#libreoffice-dev` on irc.libera.chat -
 127 we're a friendly and generally helpful mob. We know the code can be
 128 hard to get into at first, and so there are no silly questions.