File	Date	Author	Commit
doc	2018-09-29	Miquel Garriga	[28a477] docs white space cleanup
.gitignore	2022-04-30	Mehdi Chinoune	[7d7813] git ignore build directory
CMakeLists.txt	2024-07-03	Stefan Gerlach	[46a2d7] 3.0.3 release
COPYING	2010-11-07	Knut Franke	[9f5ae8] Capitalize names of documentation files
FORMAT	2017-09-17	Miquel Garriga	[f62d57] Convert file 'FORMAT' to utf-8
OriginAnyParser.cpp	2024-04-14	Stefan Gerlach	[f87f8d] update copyright
OriginAnyParser.h	2022-04-29	Mehdi Chinoune	[d0e046] Support building shared library on Windows
OriginFile.cpp	2023-07-28	Stefan Gerlach	[9977b2] update opj project version
OriginFile.h	2023-07-28	Stefan Gerlach	[9977b2] update opj project version
OriginObj.h	2024-04-14	Stefan Gerlach	[f87f8d] update copyright
OriginParser.cpp	2022-04-29	Mehdi Chinoune	[bf29c8] Remove "using namespace std" from header files.
OriginParser.h	2024-04-14	Stefan Gerlach	[f87f8d] update copyright
README	2024-04-05	Stefan Gerlach	[56dee6] update README
_clang-format	2022-04-27	Stefan Gerlach	[c514e8] add files for code formatting
clang-format.sh	2022-04-27	Stefan Gerlach	[c514e8] add files for code formatting
config.h.in	2021-05-11	Stefan Gerlach	[5516b6] Improve versioning
endianfstream.hh	2022-04-29	Mehdi Chinoune	[d0e046] Support building shared library on Windows
liborigin.pc.in	2021-05-11	Stefan Gerlach	[5516b6] Improve versioning
opj2dat.cpp	2024-04-14	Stefan Gerlach	[f87f8d] update copyright
tree.hh	2024-04-05	Stefan Gerlach	[dacb59] use const& for sibling iterators

Read Me

liborigin, standalone version
-----------------------------

This code is a standalone library for reading OriginLab project files.

It is based on the code at
	http://sourceforge.net/projects/liborigin (upstream)
	https://github.com/SciDAVis/liborigin
	http://soft.proindependent.com/liborigin2 (not available anymore)

Additionally, some fixes were applied to silence UBSan warnings caused by
uninitialised POD struct members.

AUTHORS:  
	Stefan Gerlach	2005-2024
	Miquel Garriga	2014-2018
	Knut Franke	2010
	Ion Vasilief	2006-2010
	Alex Kargovsky	2007-2009
	Russell Standish

DEPENDENCIES: tree.hh (included) http://tree.phi-sci.com/

---------------------------------------------------------------------------
COMPILING: liborigin uses CMake for the building process.
		CMake is available at http://www.cmake.org/

After installing CMake on your system, issue the following commands:
	$ mkdir build
	$ cd build
	$ cmake ..
	$ make
	$ make install

This will compile and install:
	a shared and a static version of liborigin library
	opj2dat, a program to extract data tables of an origin project into ASCII .dat files
	liborigin.pc a pkg-config metadata file to get compiler and linker flags
	c++ devel headers

To disable shared or static libraries you can also specify the cmake options
-DBUILD_SHARED_LIBS=off or -DBUILD_STATIC_LIBS=off. opj2dat will be build if one of them is enabled.

Doc generation requires doxygen (http://doxygen.org)

To include liborigin in a project using cmake add
	find_package(PkgConfig)
	pkg_check_modules(liborigin liborigin>=3.0.0)
	target_link_libraries( my_target ${liborigin_LIBRARIES} )
	target_include_directories( my_target PUBLIC ${liborigin_INCLUDE_DIRS} )
to the project CMakeLists.txt file.

To include liborigin in a project using qmake add
	CONFIG += link_pkgconfig
	PKGCONFIG += liborigin
to the project.pro file.

Logging of origin file parsing process is deactivated by default.
To enable it define a GENERATE_CODE_FOR_LOG variable at the cmake command:
    $ cmake -DGENERATE_CODE_FOR_LOG=1 ..

---------------------------------------------------------------------------
FEATURES:
	* supports the import of any OPJ project from version 3.5 to latest (2022b)
	* includes a pkg-config metadata file

---------------------------------------------------------------------------
EXAMPLES:
	* opj2dat (included) extracts the data tables of an origin project file into dat files
---------------------------------------------------------------------------
RELATED PROJECTS:
	* Ropj (https://github.com/aitap/Ropj)
	* openopj (https://github.com/jgonera/openopj)