first commit
This commit is contained in:
commit
aae803771c
1 file changed
+35
@@ -0,0 +1,35 @@
|
||||
# Searchi
|
||||
|
||||
Local desktop search for Windows, macOS and Linux. Under active development;
|
||||
production readiness is tracked in [the roadmap](docs/ROADMAP.md).
|
||||
|
||||
## Architecture
|
||||
|
||||
`crates/searchi-core` owns persistent indexing and retrieval. `crates/searchi-cli`
|
||||
provides a headless interface. `apps/desktop` hosts the Tauri desktop app.
|
||||
The initial implementation provides lexical search; semantic and media search
|
||||
are explicit upcoming milestones, not simulated features.
|
||||
|
||||
All testing in the Windows development VM uses CPU only. Indexed content stays
|
||||
local. Treat the index as sensitive: it contains extracted document text.
|
||||
|
||||
## Development
|
||||
|
||||
Install stable Rust and the platform's C/C++ build prerequisites. Run:
|
||||
|
||||
```sh
|
||||
cargo test --workspace
|
||||
cargo fmt --all -- --check
|
||||
cargo clippy --workspace --all-targets -- -D warnings
|
||||
cargo run -p searchi-cli -- --help
|
||||
```
|
||||
|
||||
Desktop development instructions live in `apps/desktop/README.md`.
|
||||
Native CI builds must pass on all supported systems before release. Cross-platform
|
||||
source support does not imply signed macOS installers can be built on Windows.
|
||||
|
||||
## Release policy
|
||||
|
||||
Do not publish until the roadmap's release gates have evidence. Record benchmark
|
||||
hardware, corpus size, cold/warm state and p95 latency. Signing credentials are
|
||||
supplied through CI secrets, never source control.
|
||||
Reference in new issue
Block a user