diff OrthancFramework/Sources/SQLite/README.txt @ 4044:d25f4c0fa160 framework

splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Core/SQLite/README.txt@9b9026560a5f
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/OrthancFramework/Sources/SQLite/README.txt	Wed Jun 10 20:30:34 2020 +0200
@@ -0,0 +1,40 @@
+Introduction
+============
+
+The code in this folder is a standalone object-oriented wrapper around
+SQLite3. It is derived from the code of Chromium:
+
+http://src.chromium.org/viewvc/chrome/trunk/src/sql/
+http://maxradi.us/documents/sqlite/
+
+
+Main differences with Chromium
+==============================
+
+* The reference counting mechanism has been reimplemented to make it 
+  simpler.
+* The OrthancException class is used for the exception mechanisms.
+* A statement is always valid (is_valid() always return true).
+* The classes and the methods have been renamed to meet Orthanc's
+  coding conventions.
+
+
+Reuse in another software
+=========================
+
+To use the Orthanc SQLite wrapper in another project than Orthanc, you
+just have to define the "ORTHANC_SQLITE_STANDALONE" macro.
+
+All the C++ exceptions generated by the wrapper will be objects of the
+class "::Orthanc::SQLite::OrthancSQLiteException", that derives from
+the standard exception class "::std::runtime_error".
+
+
+Licensing
+=========
+
+The code in this folder is licensed under the 3-clause BSD license, in
+order to respect the original license of the code.
+
+It is pretty straightforward to extract the code from this folder and
+to include it in another project.