Skip to content

Commit 0731d6c

Browse files
developernotesdevelopernotes
committed
Update README
1 parent 58666eb commit 0731d6c

2 files changed

Lines changed: 8 additions & 32 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ We welcome contributions, to contribute to SQLCipher for Android, a [contributor
1616
Add a local reference to the local library and dependency:
1717

1818
```groovy
19-
implementation files('libs/sqlcipher-android-4.12.0-release.aar')
19+
implementation files('libs/sqlcipher-android-4.14.0-release.aar')
2020
implementation 'androidx.sqlite:sqlite:2.2.0'
2121
```
2222

2323
or source a Community edition build from Maven Central:
2424

2525
```groovy
26-
implementation 'net.zetetic:sqlcipher-android:4.12.0@aar'
26+
implementation 'net.zetetic:sqlcipher-android:4.14.0@aar'
2727
implementation 'androidx.sqlite:sqlite:2.2.0'
2828
```
2929

@@ -106,27 +106,15 @@ To manage the logging produced from SQLCipher core, please review the runtime co
106106

107107
### Building
108108

109-
## Android NDK
110-
111-
Currently, SQLCipher for Android uses NDK version "25.2.9519653".
112-
113-
## External dependencies
114-
115-
This repository is not batteries-included. Specifically, you will need to build `libcrypto.a`, the static library from OpenSSL using the NDK for the [supported platforms](#compatibility), and bundle the top-level `include` folder from OpenSSL. Additionally, you will need to build a SQLCipher amalgamation. These files will need to be placed in the following locations:
109+
This project and it's dependencies can be built directly within Android Studio. Currently, SQLCipher for Android uses NDK version "25.2.9519653". The repository includes a submodule for SQLCipher core, and LibTomCrypt as external dependencies. When cloning the repository, please execute the following command at the root of the project:
116110

117111
```
118-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/armeabi-v7a/libcrypto.a
119-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/x86/libcrypto.a
120-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/x86_64/libcrypto.a
121-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/arm64-v8a/libcrypto.a
122-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/include/
123-
<project-root>/sqlcipher/src/main/jni/sqlcipher/sqlite3.c
124-
<project-root>/sqlcipher/src/main/jni/sqlcipher/sqlite3.h
112+
git submodule update --init
125113
```
126114

127115
To build the AAR package, either build directly within Android Studio, or from the command line:
128116

129117
```
130-
./gradlew assembleRelease
118+
./gradlew -PsqlcipherAndroidVerison="4.14.0" assembleRelease
131119
```
132120

‎README.md.template‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -106,27 +106,15 @@ To manage the logging produced from SQLCipher core, please review the runtime co
106106

107107
### Building
108108

109-
## Android NDK
110-
111-
Currently, SQLCipher for Android uses NDK version "<%=androidNdkVersion%>".
112-
113-
## External dependencies
114-
115-
This repository is not batteries-included. Specifically, you will need to build `libcrypto.a`, the static library from OpenSSL using the NDK for the [supported platforms](#compatibility), and bundle the top-level `include` folder from OpenSSL. Additionally, you will need to build a SQLCipher amalgamation. These files will need to be placed in the following locations:
109+
This project and it's dependencies can be built directly within Android Studio. Currently, SQLCipher for Android uses NDK version "<%=androidNdkVersion%>". The repository includes a submodule for SQLCipher core, and LibTomCrypt as external dependencies. When cloning the repository, please execute the following command at the root of the project:
116110

117111
```
118-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/armeabi-v7a/libcrypto.a
119-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/x86/libcrypto.a
120-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/x86_64/libcrypto.a
121-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/arm64-v8a/libcrypto.a
122-
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/include/
123-
<project-root>/sqlcipher/src/main/jni/sqlcipher/sqlite3.c
124-
<project-root>/sqlcipher/src/main/jni/sqlcipher/sqlite3.h
112+
git submodule update --init
125113
```
126114

127115
To build the AAR package, either build directly within Android Studio, or from the command line:
128116

129117
```
130-
./gradlew assembleRelease
118+
./gradlew -PsqlcipherAndroidVerison="<%=libraryVersion%>" assembleRelease
131119
```
132120

0 commit comments

Comments
 (0)