Port
This commit is contained in:
57
README.md
57
README.md
@@ -1,39 +1,42 @@
|
||||
# Cinny desktop
|
||||
**NOTE: This is a vibe-ported HARD FORK of the cinny-desktop repo and iOS support is untested. Have fun.**
|
||||
|
||||
<a href="https://github.com/cinnyapp/cinny-desktop/releases">
|
||||
<img alt="GitHub release downloads" src="https://img.shields.io/github/downloads/cinnyapp/cinny-desktop/total?style=social"></a>
|
||||
---
|
||||
|
||||
Cinny is a matrix client focusing primarily on simple, elegant and secure interface. The desktop app is made with Tauri.
|
||||
# Cinny Mobile
|
||||
|
||||
## Download
|
||||
Cinny is a Matrix client focused on a simple, elegant, and secure interface. This fork ports the Tauri host from desktop packaging to Tauri’s Android and iOS targets while keeping the upstream Cinny web app as the frontend.
|
||||
|
||||
Installers for macOS, Windows and Linux can be downloaded from [Github releases](https://github.com/cinnyapp/cinny-desktop/releases). Releases are signed with a [Ed25519](https://ed25519.cr.yp.to/) public-key.
|
||||
|
||||
Operating System | Download
|
||||
---|---
|
||||
Windows | <a href='https://github.com/cinnyapp/cinny-desktop/releases/latest/download/Cinny_desktop-x86_64.msi'>Get it on Windows</a>
|
||||
macOS | <a href='https://github.com/cinnyapp/cinny-desktop/releases/latest/download/Cinny_desktop-universal.dmg'>Get it on macOS</a>
|
||||
Linux | <a href='https://github.com/cinnyapp/cinny-desktop/releases/latest/download/Cinny_desktop-x86_64.AppImage'>Get it on Linux</a> · <a href='https://flathub.org/apps/details/in.cinny.Cinny'>Flatpak</a>
|
||||
## Project Layout
|
||||
|
||||
Decoded public key:
|
||||
> RWRflTUQD3RHFtn25QNANCmePR9+4LSK89kAKTMEEB4OKpOFpLMgc64z
|
||||
- `cinny/`: upstream web client, included as a git submodule
|
||||
- `src-tauri/`: Tauri mobile host, capabilities, and native project scaffolding
|
||||
|
||||
To verify release files, you need to download [minisign](https://jedisct1.github.io/minisign/) tool and [decode](https://www.base64decode.org/) the *.sig* file before running:
|
||||
> minisign -Vm ***RELEASE_FILE.msi.zip*** -P RWRflTUQD3RHFtn25QNANCmePR9+4LSK89kAKTMEEB4OKpOFpLMgc64z -x ***SINGATURE.msi.zip.sig***
|
||||
## Local Development
|
||||
|
||||
## Local development
|
||||
Follow the official [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/) first. For phone targets, also install the Android and iOS toolchains described there.
|
||||
|
||||
Firstly, to setup Rust, NodeJS and build tools follow [Tauri documentation](https://v2.tauri.app/start/prerequisites/).
|
||||
Then install dependencies:
|
||||
|
||||
Now, to setup development locally run the following commands:
|
||||
* `git clone --recursive https://github.com/cinnyapp/cinny-desktop.git`
|
||||
* `cd cinny-desktop/cinny`
|
||||
* `npm ci`
|
||||
* `cd ..`
|
||||
* `npm ci`
|
||||
- `git clone --recursive https://git.czchan.org/sneedmaster/cinny-mobile.git`
|
||||
- `cd cinny-desktop/cinny`
|
||||
- `npm ci`
|
||||
- `cd ..`
|
||||
- `npm ci`
|
||||
|
||||
To build the app locally, run:
|
||||
* `npm run tauri build`
|
||||
## Mobile Commands
|
||||
|
||||
To start local dev server, run:
|
||||
* `npm run tauri dev`
|
||||
- `npm run android:init`
|
||||
- `npm run android:dev`
|
||||
- `npm run android:build`
|
||||
- `npm run ios:init`
|
||||
- `npm run ios:dev`
|
||||
- `npm run ios: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 and iOS 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. iOS setup is intentionally deferred for now and still requires the usual Apple-side tooling plus a valid development team for signed runs.
|
||||
|
||||
Reference in New Issue
Block a user