Skip to content

Commit 38f7088

Browse files
authored
Merge pull request #340 from phoebe-leong/patch-1
add HTML keywords and properly link up the links in docs/README.md
2 parents ded6951 + f89ebff commit 38f7088

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/README.md

Lines changed: 10 additions & 9 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

@@ -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,
@@ -178,7 +179,7 @@ it's that you lack the "sqlite3" library: install the libsqlite3-dev package.
178179

179180
If you get a single linker error "Column.cpp: undefined reference to sqlite3_column_origin_name",
180181
it's that your "sqlite3" library was not compiled with
181-
the SQLITE_ENABLE_COLUMN_METADATA macro defined (see http://www.sqlite.org/compile.html#enable_column_metadata).
182+
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)).
182183
You can either recompile it yourself (seek help online) or you can comment out the following line in src/Column.h:
183184

184185
```C++
@@ -193,13 +194,13 @@ It is also tested in the same way under Windows Server 2012 R2 with Visual Studi
193194
using the AppVeyor continuous integration service.
194195

195196
Detailed results can be seen online:
196-
- https://travis-ci.org/SRombauts/SQLiteCpp
197-
- https://ci.appveyor.com/project/SbastienRombauts/SQLiteCpp
197+
- [https://travis-ci.org/SRombauts/SQLiteCpp](https://travis-ci.org/SRombauts/SQLiteCpp)
198+
- [https://ci.appveyor.com/project/SbastienRombauts/SQLiteCpp](https://ci.appveyor.com/project/SbastienRombauts/SQLiteCpp)
198199

199200
### Thread-safety
200201

201202
SQLite supports three modes of thread safety, as describe in "SQLite And Multiple Threads":
202-
see http://www.sqlite.org/threadsafe.html
203+
see [http://www.sqlite.org/threadsafe.html](http://www.sqlite.org/threadsafe.html)
203204

204205
This SQLiteC++ wrapper does no add any locks (no mutexes) nor any other thread-safety mechanism
205206
above the SQLite library itself, by design, for lightness and speed.
@@ -294,7 +295,7 @@ void assertion_failed(const char* apFile, const long apLine, const char* apFunc,
294295
### GitHub website
295296
The most efficient way to help and contribute to this wrapper project is to
296297
use the tools provided by GitHub:
297-
- please fill bug reports and feature requests here: https://github.com/SRombauts/SQLiteCpp/issues
298+
- please fill bug reports and feature requests here: [https://github.com/SRombauts/SQLiteCpp/issues](https://github.com/SRombauts/SQLiteCpp/issues)
298299
- fork the repository, make some small changes and submit them with pull-request
299300

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

313314
## See also - Some other simple C++ SQLite wrappers:
314315

0 commit comments

Comments
 (0)