Skip to content

Commit aec9656

Browse files
committed
Elaborate amalgamation instructions
1 parent a7c386e commit aec9656

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,21 @@ SQLite3 shell with sqleet encryption support can be compiled as follows:
2323
% gcc sqleet.c shell.c -o sqleet
2424
```
2525

26-
[Example](#example) illustrates sqleet encryption using the compiled shell.
26+
[Example](#example) illustrates sqleet encryption using the compiled shell. The
27+
C interface of the sqleet encryption extension is described in section [SQLite3
28+
encryption API](#sqlite3-encryption-api).
2729

2830
To use sqleet as a library, the recommended way is to download a preconfigured
2931
[release package](https://github.com/resilar/sqleet/releases/latest) instead of
30-
cloning the master. The contained `sqleet.c` and `sqleet.h` files are drop-in
31-
replacements for the official `sqlite3.c` amalgamation and `sqlite3.h` header.
32-
The C interface of the sqleet encryption extension is described in section
33-
[SQLite3 encryption API](#sqlite3-encryption-api).
34-
35-
Run `./script/amalgamate.sh <sqleet.c >amalgamation.c` to produce amalgamation
36-
of custom SQLite3/sqleet version with encryption support.
32+
cloning the source repository. Contained `sqleet.c` and `sqleet.h` files are
33+
drop-in replacements for the official `sqlite3.c` amalgamation and `sqlite3.h`
34+
header. Alternatively, `sqleet.c` and `sqleet.h` of the source repository can
35+
be used directly if all sqleet source files are available at compile time.
36+
37+
To produce a custom release version of sqleet, run `./script/amalgamate.sh
38+
<sqleet.c >release.c` to create amalgamation of SQLite3 with sqleet encryption
39+
support. Likewise, `./script/amalgamate.sh <sqleet.h >release.h` to amalgamate
40+
the header.
3741

3842

3943
Cryptography buzzwords

0 commit comments

Comments
 (0)