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)
   3
   4 LibreOffice is an integrated office suite based on copyleft licenses
   5 and compatible with most document formats and standards. Libreoffice
   6 is backed by The Document Foundation, which represents a large
   7 independent community of enterprises, developers and other volunteers
   8 moved by the common goal of bringing to the market the best software
   9 for personal productivity. LibreOffice is open source, and free to
  10 download, use and distribute.
  11
  12 A quick overview of the LibreOffice code structure.
  13
  14 ## Overview
  15
  16 You can develop for LibreOffice in one of two ways, one
  17 recommended and one much less so. First the somewhat less recommended
  18 way: it is possible to use the SDK to develop an extension,
  19 for which you can read the API docs [here](http://api.libreoffice.org/)
  20 and [here](http://wiki.services.openoffice.org/wiki/Documentation/DevGuide).
  21 This re-uses the (extremely generic) UNO APIs that are also used by
  22 macro scripting in StarBasic.
  23
  24 The best way to add a generally useful feature to LibreOffice
  25 is to work on the code base however. Overall this way makes it easier
  26 to compile and build your code, it avoids any arbitrary limitations of
  27 our scripting APIs, and in general is far more simple and intuitive -
  28 if you are a reasonably able C++ programmer.
  29
  30
  31 ## The important bits of code
  32
  33 Each module should have a `README` file inside it which has some
  34 degree of documentation for that module; patches are most welcome to
  35 improve those. We have those turned into a web page here:
  36
  37 http://docs.libreoffice.org/
  38
  39 However, there are two hundred modules, many of them of only
  40 peripheral interest for a specialist audience. So - where is the
  41 good stuff, the code that is most useful. Here is a quick overview of
  42 the most important ones:
  43
  44 Module    | Description
  45 ----------|-------------------------------------------------
  46 sal/      | this provides a simple System Abstraction Layer
  47 tools/    | this provides basic internal types: 'Rectangle', 'Color' etc.
  48 vcl/      | this is the widget toolkit library and one rendering abstraction
  49 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
  50 sfx2/     | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc.
  51 svx/      | drawing model related helper code, including much of Draw/Impress
  52
  53 Then applications
  54
  55 Module    | Description
  56 ----------|-------------------------------------------------
  57 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
  58 sw/       | Writer
  59 sc/       | Calc
  60 sd/       | Draw / Impress
  61
  62 There are several other libraries that are helpful from a graphical perspective:
  63
  64 Module    | Description
  65 ----------|-------------------------------------------------
  66 basegfx/  | algorithms and data-types for graphics as used in the canvas
  67 canvas/   | new (UNO) canvas rendering model with various backends
  68 cppcanvas/ | C++ helper classes for using the UNO canvas
  69 drawinglayer/ | View code to render drawable objects and break them down into primitives we can render more easily.
  70
  71
  72 ## Finding out more
  73
  74 Beyond this, you can read the `README` files, send us patches, ask
  75 on the mailing list libreoffice@lists.freedesktop.org (no subscription
  76 required) or poke people on IRC `#libreoffice-dev` on irc.freenode.net -
  77 we're a friendly and generally helpful mob. We know the code can be
  78 hard to get into at first, and so there are no silly questions.