Warning, /office/kexi/README.PACKAGERS.md is written in an unsupported language. File is not indexed.

0001 # Packaging Information for KEXI
0002 
0003 We recommend preparing several binary packages from the KEXI source.
0004 
0005 Splitting KEXI into packages:
0006 - gives users a better choice to install only those components they intend to use
0007 - allows users to avoid unnecessary dependencies that otherwise would have to be installed
0008 - helps to reduce packaging conflicts for users with non-standard package selections.
0009 
0010 # Table Of Contents
0011 
0012 1. Project description  
0013 2. Runtime dependencies  
0014 3. Migration drivers to package separately  
0015 4. Other plugins to package separately  
0016 5. Development files  
0017 6. Quick command-line tests of KEXI installation  
0018 
0019 # 1. Project description
0020 
0021 KEXI is a visual database applications builder. It is licensed under the LGPL 2.0 or later.
0022 To obtain complete description or metadata of the project please read the `src/data/org.kde.kexi.appdata.xml`
0023 file. You can also find links to application screenshots suitable for use on web pages.
0024 
0025 # 2. Runtime dependencies
0026 
0027 In addition to dependencies indicated at build time such as program libraries,
0028 this is a list of other runtime dependencies. Existence of each dependency is checked
0029 at configure time before actual building process starts.
0030 
0031 ## Breeze icons theme
0032 
0033 To maintain a consistent theme, KEXI project matches its application style with icons
0034 selection. For this reason Breeze is the current default. KEXI does not use individual
0035 (SVG) icon files, only the `breeze-icons.rcc` resource. Dark theme is not used.
0036 To obtain the file, contents of the [breeze-icons.git](https://quickgit.kde.org/?p=breeze-icons.git) repository have to
0037 be built with a `-DBINARY_ICONS_RESOURCE=ON` *CMake* option.
0038 
0039 # 3. Migration plugins to package separately
0040 
0041 KEXI provides migration plugins for a number of data sources or formats. We encourage to put each driver
0042 in a separate package, and that installation of these packages be optional. Each plugin package 
0043 may then depend on the corresponding 'native' libraries.
0044 
0045 ## kexi-mysql-migration
0046 
0047 Description: KEXI plugin for importing MySQL databases  
0048 Migration driver files: keximigrate_mysql.so  
0049 Dependencies: libmysqlclient
0050 
0051 ## kexi-postgresql-migration
0052 
0053 Description: KEXI plugin for importing PostgreSQL databases  
0054 Migration driver files: keximigrate_postgresql.so  
0055 Dependencies: libpq
0056 
0057 ## TODO, DISABLED for KEXI 3: kexi-sybase-migration
0058 
0059 Description: KEXI plugin for importing Sybase and MS SQL databases  
0060 Migration driver files: keximigrate_sybase.so  
0061 Dependencies: libsybdb (FreeTDS)
0062 
0063 ## TODO, DISABLED for KEXI 3: kexi-xbase-driver
0064 
0065 Description: KEXI plugin for importing dBase files  
0066 Migration driver files: keximigrate_xbase.so  
0067 Dependencies: libxbase
0068 
0069 ## TODO, DISABLED for KEXI 3: kexi-spreadsheet-import
0070 
0071 Description: KEXI plugin for importing spreadsheet files  
0072 Migration driver files: keximigrate_spreadsheet.so  
0073 Translation File: keximigrate_spreadsheet.mo  
0074 Dependencies: sheets (Calligra Sheets)
0075 
0076 Plugin .so files are typically installed to $PREFIX/lib{64}/plugins/kexi/
0077 and shared files installed to $PREFIX/share/kexi/.
0078 
0079 # 4. Other plugins to package separately
0080 
0081 KEXI provides less a number of plugin types that are optional either because are less
0082 frequently used or because have larger dependencies. We encourage to put each driver in a
0083 separate package, and that installation of these packages be optional.
0084 
0085 ## kexi-web-form-widget
0086 
0087 Description: KEXI web form widget  
0088 Contents: kformdesigner_webbrowser.so  
0089 Translation File: kformdesigner_webbrowser.mo  
0090 Dependencies: libQt5WebKit5 (provides Qt5 WebKit)
0091 
0092 ## TODO, DISABLED for KEXI 3: kexi-map-form-widget
0093 
0094 Description: KEXI map form widget  
0095 Contents: kformdesigner_mapbrowser.so  
0096 Translation File: kformdesigner_mapbrowser.mo  
0097 Dependencies: libmarble5 or marble (provides libmarblewidget-qt5)
0098 
0099 # 5. Development files
0100 
0101 KEXI ships no public development files at the moment, so -devel packages are not needed.
0102 
0103 # 6. Quick command-line tests of KEXI installation
0104 
0105 If you don't want to click through KEXI interface but still want to make (almost) sure the
0106 application is properly packaged, please install it and type the following from the command
0107 line:
0108 
0109     kexi --create-opendb --drv org.kde.kdb.sqlite --new form testdb
0110 
0111 (ignore possible warning messages)
0112 
0113 This will:
0114 - create a new empty SQLite3-based file "testdb",
0115 - open it,
0116 - create a new empty form.