/kf6-qt6/education/labplot/src/3rdparty/liborigin/README

0001 liborigin, standalone version
0002 ---------------------
0003
0004 This code is a standalone library for reading OriginLab project files.
0005
0006 It is based on the code at
0007         http://sourceforge.net/projects/liborigin (upstream)
0008         https://github.com/SciDAVis/liborigin
0009         http://soft.proindependent.com/liborigin2 (not available anymore)
0010
0011 Additionally, some fixes were applied to silence UBSan warnings caused by
0012 uninitialised POD struct members.
0013
0014 AUTHORS:
0015         Stefan Gerlach  2005-2023
0016         Miquel Garriga  2014-2018
0017         Knut Franke     2010
0018         Ion Vasilief    2006-2010
0019         Alex Kargovsky  2007-2009
0020         Russell Standish
0021
0022 DEPENDENCIES: tree.hh (included) http://tree.phi-sci.com/
0023
0024 ---------------------------------------------------------------------------
0025 COMPILING: liborigin uses CMake for the building process.
0026                 CMake is available at http://www.cmake.org/
0027
0028 After installing CMake on your system, issue the following commands:
0029         $ mkdir build
0030         $ cd build
0031         $ cmake ..
0032         $ make
0033         $ make install
0034
0035 This will compile and install:
0036         a shared and a static version of liborigin library
0037         opj2dat, a program to extract data tables of an origin project into ASCII .dat files
0038         liborigin.pc a pkg-config metadata file to get compiler and linker flags
0039         c++ devel headers
0040
0041 To disable shared or static libraries you can also specify the cmake options
0042 -DBUILD_SHARED_LIBS=off or -DBUILD_STATIC_LIBS=off. opj2dat will be build if one of them is enabled.
0043
0044 Doc generation requires doxygen (http://doxygen.org)
0045
0046 To include liborigin in a project using cmake add
0047         find_package(PkgConfig)
0048         pkg_check_modules(liborigin liborigin>=3.0.0)
0049         target_link_libraries( my_target ${liborigin_LIBRARIES} )
0050         target_include_directories( my_target PUBLIC ${liborigin_INCLUDE_DIRS} )
0051 to the project CMakeLists.txt file.
0052
0053 To include liborigin in a project using qmake add
0054         CONFIG += link_pkgconfig
0055         PKGCONFIG += liborigin
0056 to the project.pro file.
0057
0058 Logging of origin file parsing process is deactivated by default.
0059 To enable it define a GENERATE_CODE_FOR_LOG variable at the cmake command:
0060     $ cmake -DGENERATE_CODE_FOR_LOG=1 ..
0061
0062 ---------------------------------------------------------------------------
0063 FEATURES:
0064         * supports the import of any project from version 3.5 to latest (2022b)
0065         * includes a pkg-config metadata file
0066
0067 ---------------------------------------------------------------------------
0068 EXAMPLES:
0069         * opj2dat (included) extracts the data tables of an origin project file into dat files
0070 ---------------------------------------------------------------------------
0071 RELATED PROJECTS:
0072         * Ropj (https://github.com/aitap/Ropj)
0073         * openopj (https://github.com/jgonera/openopj)