Skip to content

Commit 3aeeb8d

Browse files
committed
Sync the two README since I made a copy on docs/ folder :(
1 parent 0da8c46 commit 3aeeb8d

File tree

2 files changed

+40
-29
lines changed

2 files changed

+40
-29
lines changed

README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ SQLiteC++
1212

1313
SQLiteC++ (SQLiteCpp) is a smart and easy to use C++ SQLite3 wrapper.
1414

15-
Keywords: sqlite, sqlite3, C, library, wrapper C++
15+
<!--Keywords: sqlite, sqlite3, C, library, wrapper C++-->
16+
<meta name="keywords" content="sqlite, sqlite3, C, library, wrapper C++">
1617

1718
## About SQLiteC++:
1819

@@ -21,7 +22,7 @@ with a few intuitive and well documented C++ classes.
2122

2223
### License:
2324

24-
Copyright (c) 2012-2020 Sébastien Rombauts ([email protected])
25+
Copyright (c) 2012-2021 Sébastien Rombauts ([email protected])
2526
<a href="https://www.paypal.me/SRombauts" title="Pay Me a Beer! Donate with PayPal :)"><img src="https://www.paypalobjects.com/webstatic/paypalme/images/pp_logo_small.png" width="118"></a>
2627

2728
Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
@@ -40,7 +41,7 @@ but none of those are mandatory.
4041
SQLite is a library that implements a serverless transactional SQL database engine.
4142
It is the most widely deployed SQL database engine in the world.
4243
All of the code and documentation in SQLite has been dedicated to the public domain by the authors.
43-
http://www.sqlite.org/about.html
44+
[http://www.sqlite.org/about.html](http://www.sqlite.org/about.html)
4445

4546
### The goals of SQLiteC++ are:
4647

@@ -57,7 +58,7 @@ http://www.sqlite.org/about.html
5758
- to use a permissive MIT license, similar to BSD or Boost, for proprietary/commercial usage
5859

5960
It is designed using the Resource Acquisition Is Initialization (RAII) idiom
60-
(see http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization),
61+
(see [http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization](http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization)),
6162
and throwing exceptions in case of SQLite errors (except in destructors,
6263
where assert() are used instead).
6364
Each SQLiteC++ object must be constructed with a valid SQLite database connection,
@@ -127,20 +128,20 @@ git submodule init
127128
git submodule update
128129
```
129130

130-
#### Using SQLiteCpp on a system-wide installation
131-
132-
If you installed this package to your system, a `SQLiteCppConfig.cmake` file will be generated & installed to your system.
133-
This file lets you link against the SQLiteCpp library for use in your Cmake project.
134-
135-
Here's an example of using this in your CMakeLists.txt
136-
```cmake
137-
# You can optionally define a minimum version in this call
138-
find_package(SQLiteCpp REQUIRED)
139-
# For this example, lets say you created an target with add_executable (or add_library) called "my_target"
140-
# You can optionally declare PUBLIC or PRIVATE linkage here, depending on your needs.
141-
target_link_libraries(my_target PRIVATE SQLiteCpp)
142-
```
143-
131+
#### Using SQLiteCpp on a system-wide installation
132+
133+
If you installed this package to your system, a `SQLiteCppConfig.cmake` file will be generated & installed to your system.
134+
This file lets you link against the SQLiteCpp library for use in your Cmake project.
135+
136+
Here's an example of using this in your CMakeLists.txt
137+
```cmake
138+
# You can optionally define a minimum version in this call
139+
find_package(SQLiteCpp REQUIRED)
140+
# For this example, lets say you created an target with add_executable (or add_library) called "my_target"
141+
# You can optionally declare PUBLIC or PRIVATE linkage here, depending on your needs.
142+
target_link_libraries(my_target PRIVATE SQLiteCpp)
143+
```
144+
144145
#### CMake and tests
145146
A CMake configuration file is also provided for multi-platform support and testing.
146147

@@ -188,7 +189,7 @@ it's that you lack the "sqlite3" library: install the libsqlite3-dev package.
188189

189190
If you get a single linker error "Column.cpp: undefined reference to sqlite3_column_origin_name",
190191
it's that your "sqlite3" library was not compiled with
191-
the SQLITE_ENABLE_COLUMN_METADATA macro defined (see http://www.sqlite.org/compile.html#enable_column_metadata).
192+
the SQLITE_ENABLE_COLUMN_METADATA macro defined (see [http://www.sqlite.org/compile.html#enable_column_metadata](http://www.sqlite.org/compile.html#enable_column_metadata)).
192193
You can either recompile it yourself (seek help online) or you can comment out the following line in src/Column.h:
193194

194195
```C++
@@ -203,13 +204,13 @@ It is also tested in the same way under Windows Server 2012 R2 with Visual Studi
203204
using the AppVeyor continuous integration service.
204205

205206
Detailed results can be seen online:
206-
- https://travis-ci.org/SRombauts/SQLiteCpp
207-
- https://ci.appveyor.com/project/SbastienRombauts/SQLiteCpp
207+
- [https://travis-ci.org/SRombauts/SQLiteCpp](https://travis-ci.org/SRombauts/SQLiteCpp)
208+
- [https://ci.appveyor.com/project/SbastienRombauts/SQLiteCpp](https://ci.appveyor.com/project/SbastienRombauts/SQLiteCpp)
208209

209210
### Thread-safety
210211

211212
SQLite supports three modes of thread safety, as describe in "SQLite And Multiple Threads":
212-
see http://www.sqlite.org/threadsafe.html
213+
see [http://www.sqlite.org/threadsafe.html](http://www.sqlite.org/threadsafe.html)
213214

214215
This SQLiteC++ wrapper does no add any locks (no mutexes) nor any other thread-safety mechanism
215216
above the SQLite library itself, by design, for lightness and speed.
@@ -304,7 +305,7 @@ void assertion_failed(const char* apFile, const long apLine, const char* apFunc,
304305
### GitHub website
305306
The most efficient way to help and contribute to this wrapper project is to
306307
use the tools provided by GitHub:
307-
- please fill bug reports and feature requests here: https://github.com/SRombauts/SQLiteCpp/issues
308+
- please fill bug reports and feature requests here: [https://github.com/SRombauts/SQLiteCpp/issues](https://github.com/SRombauts/SQLiteCpp/issues)
308309
- fork the repository, make some small changes and submit them with pull-request
309310

310311
### Contact
@@ -318,7 +319,7 @@ The source code use the CamelCase naming style variant where:
318319
- member variables begin with a 'm', function arguments begin with a 'a', booleans with a 'b', pointers with a 'p'
319320
- each file, class, method and member variable is documented using Doxygen tags
320321
- braces on their own line
321-
See also http://www.appinf.com/download/CppCodingStyleGuide.pdf for good guidelines
322+
See also [http://www.appinf.com/download/CppCodingStyleGuide.pdf](http://www.appinf.com/download/CppCodingStyleGuide.pdf) for good guidelines
322323

323324
## See also - Some other simple C++ SQLite wrappers:
324325

docs/README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ with a few intuitive and well documented C++ classes.
2222

2323
### License:
2424

25-
Copyright (c) 2012-2020 Sébastien Rombauts ([email protected])
25+
Copyright (c) 2012-2021 Sébastien Rombauts ([email protected])
2626
<a href="https://www.paypal.me/SRombauts" title="Pay Me a Beer! Donate with PayPal :)"><img src="https://www.paypalobjects.com/webstatic/paypalme/images/pp_logo_small.png" width="118"></a>
2727

2828
Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
@@ -104,10 +104,6 @@ Example for Linux:
104104
```cmake
105105
add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/thirdparty/SQLiteCpp)
106106
107-
include_directories(
108-
${CMAKE_CURRENT_LIST_DIR}/thirdparty/SQLiteCpp/include
109-
)
110-
111107
add_executable(main src/main.cpp)
112108
target_link_libraries(main
113109
SQLiteCpp
@@ -132,6 +128,20 @@ git submodule init
132128
git submodule update
133129
```
134130

131+
#### Using SQLiteCpp on a system-wide installation
132+
133+
If you installed this package to your system, a `SQLiteCppConfig.cmake` file will be generated & installed to your system.
134+
This file lets you link against the SQLiteCpp library for use in your Cmake project.
135+
136+
Here's an example of using this in your CMakeLists.txt
137+
```cmake
138+
# You can optionally define a minimum version in this call
139+
find_package(SQLiteCpp REQUIRED)
140+
# For this example, lets say you created an target with add_executable (or add_library) called "my_target"
141+
# You can optionally declare PUBLIC or PRIVATE linkage here, depending on your needs.
142+
target_link_libraries(my_target PRIVATE SQLiteCpp)
143+
```
144+
135145
#### CMake and tests
136146
A CMake configuration file is also provided for multi-platform support and testing.
137147

0 commit comments

Comments
 (0)