From 3b82360a45e40e81f3c3f07d2a6b9ab305ff334e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Rombauts?= Date: Wed, 4 Apr 2012 20:11:03 +0200 Subject: [PATCH] Explaining goals of the project --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60c1a27..837e76a 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,22 @@ or copy at [http://opensource.org/licenses/MIT]) SQLiteC++ is a smart and simple C++ SQLite3 wrapper, easy to use and efficient. +The goals of SQLiteC++ are: + +- to offer the best of actual existing simple wrappers +- to use a permissible license like MIT or BSD +- to be elegantly written with good C++ design, STL, exceptions and RAII idiom +- to keep dependencies to a minimum (STL and SQLite3) +- to be well documented, in code with Doxygen, and online with some good examples +- to be portable +- to be light and fast +- to use API names sticking with those of the SQLite library + It is designed with the Resource Acquisition Is Initialization (RAII) idom (see http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization), and throw exceptions in case of SQLite errors. - -Each SQLiteC++ object must be constructed with a valid SQLite database connexion, and then is always valid until destroyed. +Each SQLiteC++ object must be constructed with a valid SQLite database connexion, +and then is always valid until destroyed. Depandancies: