cinny-desktop/README.md

36 lines
1.4 KiB
Markdown
Raw Normal View History

2022-04-29 14:43:18 +00:00
# Cinny desktop
<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>
2022-05-03 15:50:25 +00:00
Dekstop app of Cinny made with Tauri. Cinny is a matrix client focusing primarily on simple, elegant and secure interface.
![Image](resources/screenshot2.png)
2022-04-29 14:43:18 +00:00
## Download
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.
Decoded pulic key:
> RWRflTUQD3RHFtn25QNANCmePR9+4LSK89kAKTMEEB4OKpOFpLMgc64z
2022-05-27 08:29:45 +00:00
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***
2022-04-29 14:43:18 +00:00
## Local development
2022-06-30 05:40:49 +00:00
Firstly, to setup Rust, NodeJS and build tools follow [Tauri documentation](https://tauri.app/v1/guides/getting-started/prerequisites).
2022-05-03 15:50:25 +00:00
Now, to setup development locally run the following commands:
2022-04-29 14:43:18 +00:00
* `git clone --recursive https://github.com/cinnyapp/cinny-desktop.git`
* `cd cinny`
* `npm ci`
* `cd ..`
* `npm ci`
2022-05-03 15:50:25 +00:00
To build the app locally, run:
2022-04-29 14:43:18 +00:00
* `npm run tauri build`
To start local dev server, run:
* `npm run tauri dev`