status-im/sqlcipher
2
0
Fork 0
mirror of https://github.com/status-im/sqlcipher.git synced 2025-02-22 08:48:10 +00:00
Code Issues Projects Releases Wiki Activity

Fix some formatting and grammar in README.md

Browse Source
This commit is contained in:
Jeremy Lin 2021-10-04 13:41:03 -07:00
parent 0663d85002
commit a422e6d256
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -32,9 +32,9 @@ The SQLCipher team welcomes contributions to the core library. All contributions
## Compiling
Building SQLCipher is similar to compiling a regular version of SQLite from source a couple small exceptions:
Building SQLCipher is similar to compiling a regular version of SQLite from source, with a couple of small exceptions:
1. You *must* define `SQLITE_HAS_CODEC` and either `SQLITE_TEMP_STORE=2` or SQLITE_TEMP_STORE=3`
1. You *must* define `SQLITE_HAS_CODEC` and either `SQLITE_TEMP_STORE=2` or `SQLITE_TEMP_STORE=3`
2. You will need to link against a support cryptographic provider (OpenSSL, LibTomCrypt, CommonCrypto/Security.framework, or NSS)
The following examples demonstrate linking against OpenSSL, which is a readily available provider on most Unix-like systems.
@ -43,17 +43,17 @@ Example 1. Static linking (replace /opt/local/lib with the path to libcrypto.a).
example, `--enable-tempstore=yes` is setting `SQLITE_TEMP_STORE=2` for the build.
```
$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
LDFLAGS="/opt/local/lib/libcrypto.a"
$ make
$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
LDFLAGS="/opt/local/lib/libcrypto.a"
$ make
```
Example 2. Dynamic linking
```
$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
LDFLAGS="-lcrypto"
$ make
$ ./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
LDFLAGS="-lcrypto"
$ make
```
## Testing
@ -65,10 +65,10 @@ As a result, the SQLCipher package includes it's own independent tests that exer
To run SQLCipher specific tests, configure as described here and run the following to execute the tests and receive a report of the results:
```
$ ./configure --enable-tempstore=yes --enable-fts5 CFLAGS="-DSQLITE_HAS_CODEC -DSQLCIPHER_TEST" \
LDFLAGS="-lcrypto"
$ make testfixture
$ ./testfixture test/sqlcipher.test
$ ./configure --enable-tempstore=yes --enable-fts5 CFLAGS="-DSQLITE_HAS_CODEC -DSQLCIPHER_TEST" \
LDFLAGS="-lcrypto"
$ make testfixture
$ ./testfixture test/sqlcipher.test
```
## Encrypting a database