Skip to content

Commit a6b5041

Browse files
author
Sébastien Rombauts
committed
Add a simple README file with build instruction, and a LICENSE
1 parent 062ad5b commit a6b5041

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

LICENSE.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2012-2016 Sebastien Rombauts ([email protected])
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is furnished
10+
to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
20+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
SQLiteC++
2+
---------
3+
4+
[SQLiteC++ (SQLiteCpp)](https://github.com/SRombauts/SQLiteCpp) is a smart and easy to use C++ SQLite3 wrapper.
5+
6+
[See SQLiteC++ website on GitHub](http://srombauts.github.com/SQLiteCpp).
7+
8+
Keywords: sqlite, sqlite3, C, library, wrapper C++, simple example
9+
10+
## About SQLiteC++:
11+
12+
SQLiteC++ offers an encapsulation around the native C APIs of SQLite,
13+
with a few intuitive and well documented C++ classes.
14+
15+
### License:
16+
17+
Copyright (c) 2012-2016 Sébastien Rombauts ([email protected])
18+
19+
Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
20+
or copy at http://opensource.org/licenses/MIT)
21+
22+
## Getting started
23+
### Git:
24+
25+
Use git to clone the repository. Then init and update submodule "SQLiteCpp".
26+
27+
```Shell
28+
git clone https://github.com/SRombauts/SQLiteCpp_Example.git
29+
cd SQLiteCpp_Example
30+
git submodule init
31+
git submodule update
32+
```
33+
34+
### CMake and build:
35+
36+
Use build.bat or ./build.sh script, or cmake commande line (example for Linux):
37+
38+
```Shell
39+
mkdir -p build
40+
cd build
41+
42+
# Generate a Makefile for GCC (or Clang, depanding on CC/CXX envvar)
43+
cmake ..
44+
45+
# Build (ie 'make')
46+
cmake --build .
47+
```
48+
49+
On Windows, you can also open the Visual Studio Solution (in the build/ subdirectory).
50+
51+
### Run
52+
53+
Launch build/SQLiteCpp_Example(.exe) from the command line
54+
55+
## How to contribute
56+
### GitHub website
57+
The most efficient way to help and contribute to this wrapper project is to
58+
use the tools provided by GitHub:
59+
- please fill bug reports and feature requests here: https://github.com/SRombauts/SQLiteCpp/issues
60+
- fork the repository, make some small changes and submit them with pull-request
61+

0 commit comments

Comments
 (0)