chore: rename quicproquo → quicprochat in docs, Docker, CI, and packaging
Rename all project references from quicproquo/qpq to quicprochat/qpc across documentation, Docker configuration, CI workflows, packaging scripts, operational configs, and build tooling. - Docker: crate paths, binary names, user/group, data dirs, env vars - CI: workflow crate references, binary names, artifact names - Docs: all markdown files under docs/, SDK READMEs, book.toml - Packaging: OpenWrt Makefile, init script, UCI config (file renames) - Scripts: justfile, dev-shell, screenshot, cross-compile, ai_team - Operations: Prometheus config, alert rules, Grafana dashboard - Config: .env.example (QPQ_* → QPC_*), CODEOWNERS paths - Top-level: README, CONTRIBUTING, ROADMAP, CLAUDE.md
This commit is contained in:
@@ -1,34 +1,34 @@
|
||||
# QuicProQuo Kotlin SDK
|
||||
# QuicProChat Kotlin SDK
|
||||
|
||||
Kotlin/JVM wrapper over `libquicproquo_ffi` via JNI for Android and JVM platforms.
|
||||
Kotlin/JVM wrapper over `libquicprochat_ffi` via JNI for Android and JVM platforms.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kotlin 1.9+ / JDK 17+
|
||||
- `libquicproquo_ffi` built for the target architecture
|
||||
- JNI bridge compiled (`jni/dev_quicproquo_NativeBridge.c`)
|
||||
- `libquicprochat_ffi` built for the target architecture
|
||||
- JNI bridge compiled (`jni/dev_quicprochat_NativeBridge.c`)
|
||||
|
||||
## Building the Native Library
|
||||
|
||||
```sh
|
||||
# Linux (JVM)
|
||||
cargo build --release -p quicproquo-ffi
|
||||
cargo build --release -p quicprochat-ffi
|
||||
|
||||
# Android (aarch64)
|
||||
cargo build --release -p quicproquo-ffi --target aarch64-linux-android
|
||||
cargo build --release -p quicprochat-ffi --target aarch64-linux-android
|
||||
|
||||
# Android (armv7)
|
||||
cargo build --release -p quicproquo-ffi --target armv7-linux-androideabi
|
||||
cargo build --release -p quicprochat-ffi --target armv7-linux-androideabi
|
||||
```
|
||||
|
||||
### Compiling the JNI Bridge
|
||||
|
||||
```sh
|
||||
cd jni
|
||||
gcc -shared -fPIC -o libquicproquo_jni.so \
|
||||
gcc -shared -fPIC -o libquicprochat_jni.so \
|
||||
-I"$JAVA_HOME/include" -I"$JAVA_HOME/include/linux" \
|
||||
dev_quicproquo_NativeBridge.c \
|
||||
-L ../../../../target/release -lquicproquo_ffi
|
||||
dev_quicprochat_NativeBridge.c \
|
||||
-L ../../../../target/release -lquicprochat_ffi
|
||||
```
|
||||
|
||||
## Installation
|
||||
@@ -37,7 +37,7 @@ gcc -shared -fPIC -o libquicproquo_jni.so \
|
||||
|
||||
```kotlin
|
||||
dependencies {
|
||||
implementation(files("libs/quicproquo-0.1.0.jar"))
|
||||
implementation(files("libs/quicprochat-0.1.0.jar"))
|
||||
}
|
||||
```
|
||||
|
||||
@@ -46,7 +46,7 @@ Or include as a local project module.
|
||||
## Usage
|
||||
|
||||
```kotlin
|
||||
import dev.quicproquo.QpqClient
|
||||
import dev.quicprochat.QpqClient
|
||||
|
||||
val client = QpqClient("127.0.0.1:5001", caCertPath = "ca.pem")
|
||||
|
||||
@@ -86,16 +86,16 @@ try {
|
||||
|
||||
## Structure
|
||||
|
||||
- `src/main/kotlin/dev/quicproquo/QpqClient.kt` -- High-level client
|
||||
- `src/main/kotlin/dev/quicproquo/NativeBridge.kt` -- JNI declarations
|
||||
- `src/main/kotlin/dev/quicproquo/QpqError.kt` -- Exception types
|
||||
- `jni/dev_quicproquo_NativeBridge.c` -- JNI C bridge to FFI
|
||||
- `src/main/kotlin/dev/quicprochat/QpqClient.kt` -- High-level client
|
||||
- `src/main/kotlin/dev/quicprochat/NativeBridge.kt` -- JNI declarations
|
||||
- `src/main/kotlin/dev/quicprochat/QpqError.kt` -- Exception types
|
||||
- `jni/dev_quicprochat_NativeBridge.c` -- JNI C bridge to FFI
|
||||
|
||||
## Android Integration
|
||||
|
||||
1. Add the native libraries to `src/main/jniLibs/<abi>/`:
|
||||
- `arm64-v8a/libquicproquo_ffi.so`
|
||||
- `armeabi-v7a/libquicproquo_ffi.so`
|
||||
- `arm64-v8a/libquicprochat_ffi.so`
|
||||
- `armeabi-v7a/libquicprochat_ffi.so`
|
||||
2. Add the JNI bridge library alongside
|
||||
3. The `NativeBridge` class loads the library via `System.loadLibrary`
|
||||
|
||||
@@ -107,5 +107,5 @@ rustup target add aarch64-linux-android armv7-linux-androideabi
|
||||
|
||||
# Build with the NDK linker
|
||||
CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER=aarch64-linux-android21-clang \
|
||||
cargo build --release -p quicproquo-ffi --target aarch64-linux-android
|
||||
cargo build --release -p quicprochat-ffi --target aarch64-linux-android
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user