Merge 4f74926ad6ca394871edfcd9ef7a649523626714 into 71f7b8a485147e61deae3c2975872ff755a13d0c

This commit is contained in:
kaichao 2026-02-09 10:07:29 -08:00 committed by GitHub
commit 364058621e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 58 additions and 3 deletions

View File

@ -1,2 +1,45 @@
# libchat
Supporting library for Logos-chat
Supporting library for Logos-chat.
## Prerequisites
Install Rust via [rustup](https://rust-lang.org/tools/install/):
## Quick Start
### Using Cargo
```bash
# Build
cargo build
# Run tests
cargo test
# Run examples
cargo run --example double_ratchet_basic
```
### Using Just
Install [just](https://github.com/casey/just) to manage complex tasks.
On MacOS, you can install it via Homebrew:
```bash
brew install just
```
After that, run:
```bash
# Build
just build
# Run tests
just test
# Run all examples
just run-examples
```

View File

@ -20,8 +20,7 @@ Run examples,
```bash
cargo run --example double_ratchet_basic
cargo run --example storage_demo --features storage
cargo run --example storage_demo --features sqlcipher
cargo run --example storage_demo
```
Run Nim FFI example,

13
justfile Normal file
View File

@ -0,0 +1,13 @@
# The first receipt is the default task, run with `just`
build:
cargo build
test:
cargo test
# Run all examples
run-examples:
cargo run --example double_ratchet_basic
cargo run --example serialization_demo
cargo run --example storage_demo
cargo run --example out_of_order_demo