Files
cinny-mobile/README.md

40 lines
1.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
**NOTE: This is a vibe-ported HARD FORK of the cinny-desktop repo and is now Android-only. Have fun.**
---
# Cinny Mobile
Cinny is a Matrix client focused on a simple, elegant, and secure interface. This fork ports the Tauri host from desktop packaging to Tauris Android target while keeping the upstream Cinny web app as the frontend.
## Project Layout
- `cinny/`: upstream web client, included as a git submodule
- `src-tauri/`: Tauri mobile host, capabilities, and native project scaffolding
## Local Development
Follow the official [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/) first. For phone builds, also install the Android toolchain described there.
Then install dependencies:
- `git clone --recursive https://git.czchan.org/sneedmaster/cinny-mobile.git`
- `cd cinny-desktop/cinny`
- `npm ci`
- `cd ..`
- `npm ci`
## Mobile Commands
- `npm run android:init`
- `npm run android:dev`
- `npm run android:build`
`npm run tauri dev` is still useful for validating the shared Tauri host on the current machine before deploying to a handset or simulator.
## Notes
- The Tauri entrypoint lives in src-tauri/src/lib.rs and is shared by desktop dev runs plus Android builds.
- Production assets are served through `tauri-plugin-localhost` so the wrapped web app can continue using its existing browser-oriented runtime behavior.
- Android scaffolding has been regenerated in this workspace and is the only mobile target maintained by this fork.