Skip to content

Commit e1d8119

Browse files
More README fixes
1 parent 3d651f5 commit e1d8119

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Easily build a custom SQLite static library for use in OSX and iOS frameworks an
55

66
If you need a specific version of SQLite, or specific SQLite compilation options/features, read on.
77

8-
9-
---
8+
==========
109

1110
**May 29, 2016: SQLiteLib updated for SQLite 3.13.0** ([changelog](CHANGELOG.md)).
1211

@@ -15,7 +14,12 @@ If you need a specific version of SQLite, or specific SQLite compilation options
1514
**SQLite Included:** 3.13.0
1615

1716

18-
### Installation
17+
18+
---
19+
20+
### Installation:
21+
22+
==========
1923

2024
#### Manual Installation (ex. into a Framework)
2125

@@ -26,17 +30,22 @@ If you need a specific version of SQLite, or specific SQLite compilation options
2630

2731
That's it! (You'll probably also want to `#include "sqlite3.h"` somewhere. SQLiteLib copies this generated file to its project directory.)
2832

33+
==========
34+
2935
#### Using in Swift
3036

3137
You probably shouldn't be using the raw SQLite C API in Swift. There are a bunch of great libraries available that wrap it.
3238

3339
For example: ([GRDB.swift](https://github.com/groue/GRDB.swift)).
3440

41+
---
3542

36-
### Customization
43+
### Customization:
3744

3845
By default, SQLiteLib builds SQLite with options that match the built-in system version of SQLite on OSX and iOS (as of OSX 10.11.5, iOS 9.3.2), [with one exception*](#additional-details).
3946

47+
==========
48+
4049
#### Specifying Additional SQLite Compilation Options
4150

4251
> By default, SQLiteLib compiles SQLite with options that match the built-in OSX/iOS version of SQLite (as of OSX 10.11, iOS 9.3.2), with one exception*.
@@ -49,12 +58,13 @@ To specify additional options:
4958

5059
For example, to specify SQLITE\_ENABLE\_PREUPDATE\_HOOK, you would modify it like this:
5160
```ini
52-
CUSTOM\_SQLLIBRARY\_CFLAGS = -DSQLITE\_ENABLE\_PREUPDATE\_HOOK
61+
CUSTOM_SQLLIBRARY_CFLAGS = -DSQLITE_ENABLE_PREUPDATE_HOOK
5362
```
5463

5564
That's it.
5665
There is no need to modify any other files.
5766

67+
==========
5868

5969
#### Compiling a Specific Version of SQLite
6070

@@ -73,14 +83,19 @@ If you'd like to compile a newer (or older) version, the process is simple:
7383
> Setting compilation options using the SQLite amalgamation is not guaranteed to work:
7484
> > The versions of the SQLite amalgamation that are supplied on the download page are normally adequate for most users. However, some projects may want or need to build their own amalgamations. A common reason for building a custom amalgamation is in order to use certain compile-time options to customize the SQLite library. Recall that the SQLite amalgamation contains a lot of C-code that is generated by auxiliary programs and scripts. Many of the compile-time options effect this generated code and **must be supplied to the code generators before the amalgamation is assembled**.
7585
86+
==========
87+
7688
**Quick Guide to Using the Latest version of SQLite**:
7789

7890
The snapshop of the complete (raw) source tree for the *current* version of SQLite is available on the ([SQLite Download Page](https://www.sqlite.org/download.html#old)) under: **Alternative Source Code Formats**.
7991
You'll want the file named "sqlite-src-*version*.zip".
8092
> Do **NOT** use the file beginning with "sqlite-preprocessed" - it will not work properly.
8193
94+
---
8295

83-
### Additional Details
96+
### Additional Details:
97+
98+
==========
8499

85100
#### Default Compilation Options
86101

@@ -137,6 +152,8 @@ To prevent this warning, SQLiteLib separately specifies `-Wno-#warnings` when bu
137152
All of these base settings are configured in the SQLiteLib.xcconfig file.
138153
It is strongly recommended that you do not edit this file. If you'd like to specify additional compilation options, see [the instructions above](#specifying-additional-sqlite-compilation-options)
139154

155+
==========
156+
140157
#### Build Locations
141158

142159
SQLiteLib generates intermediate files in [${DERIVED_SOURCES_DIR}](https://developer.apple.com/library/mac/documentation/DeveloperTools/Reference/XcodeBuildSettingRef/1-Build_Setting_Reference/build_setting_ref.html#//apple_ref/doc/uid/TP40003931-CH3-SW43).
@@ -147,7 +164,9 @@ The generated SQLite amalgamation files are copied to:
147164

148165
-"${PROJECT_DIR}/sqlite3.h"
149166

150-
#### Notes
167+
---
168+
169+
#### Notes:
151170

152171
##### "sqlite3.c" shows as red/missing in Xcode
153172

0 commit comments

Comments
 (0)