From 93af906ea96154782ac226916ae39af1e40c72d9 Mon Sep 17 00:00:00 2001 From: kaichaosun Date: Fri, 30 Jan 2026 15:56:51 +0800 Subject: [PATCH 1/4] feat: use just for quick tasks. --- README.md | 27 ++++++++++++++++++++++++++- double-ratchets/README.md | 3 +-- justfile | 13 +++++++++++++ 3 files changed, 40 insertions(+), 3 deletions(-) create mode 100644 justfile diff --git a/README.md b/README.md index 62066bc..5e4ff3f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # libchat -Supporting library for Logos-chat + +Supporting library for Logos-chat. + +## Quick Start + +Install [just](https://github.com/casey/just) to manage 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 +``` + diff --git a/double-ratchets/README.md b/double-ratchets/README.md index 974deda..345510d 100644 --- a/double-ratchets/README.md +++ b/double-ratchets/README.md @@ -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, diff --git a/justfile b/justfile new file mode 100644 index 0000000..5d0d7fb --- /dev/null +++ b/justfile @@ -0,0 +1,13 @@ +# The first receipt is default with build +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 From 6d21499477748b44278337f40276af10749c5566 Mon Sep 17 00:00:00 2001 From: kaichaosun Date: Fri, 30 Jan 2026 15:59:12 +0800 Subject: [PATCH 2/4] chore: improve default task run command --- justfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/justfile b/justfile index 5d0d7fb..a7b192e 100644 --- a/justfile +++ b/justfile @@ -1,4 +1,4 @@ -# The first receipt is default with build +# The first receipt is the default task, run with `just` build: cargo build From 36ef22b84d418249dafa1148ef75b482b9677c36 Mon Sep 17 00:00:00 2001 From: kaichaosun Date: Tue, 3 Feb 2026 11:03:18 +0800 Subject: [PATCH 3/4] chore: add cargo to start --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5e4ff3f..6458683 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,22 @@ Supporting library for Logos-chat. ## Quick Start -Install [just](https://github.com/casey/just) to manage tasks. +### 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: @@ -24,4 +39,3 @@ just test # Run all examples just run-examples ``` - From 4f74926ad6ca394871edfcd9ef7a649523626714 Mon Sep 17 00:00:00 2001 From: kaichaosun Date: Tue, 3 Feb 2026 11:05:54 +0800 Subject: [PATCH 4/4] chore: install rust --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6458683..a633a46 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Supporting library for Logos-chat. +## Prerequisites + +Install Rust via [rustup](https://rust-lang.org/tools/install/): + ## Quick Start ### Using Cargo